NeoMutt  2020-09-25
Teaching an old dog new tricks
DOXYGEN
connaccount.h File Reference

Connection Credentials. More...

#include <stdint.h>
+ Include dependency graph for connaccount.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ConnAccount
 Login details for a remote server. More...
 

Macros

#define MUTT_ACCT_NO_FLAGS   0
 No flags are set. More...
 
#define MUTT_ACCT_PORT   (1 << 0)
 Port field has been set. More...
 
#define MUTT_ACCT_USER   (1 << 1)
 User field has been set. More...
 
#define MUTT_ACCT_LOGIN   (1 << 2)
 Login field has been set. More...
 
#define MUTT_ACCT_PASS   (1 << 3)
 Password field has been set. More...
 
#define MUTT_ACCT_SSL   (1 << 4)
 Account uses SSL/TLS. More...
 

Typedefs

typedef uint8_t MuttAccountFlags
 Flags, Which ConnAccount fields are initialised, e.g. MUTT_ACCT_PORT. More...
 

Enumerations

enum  ConnAccountField {
  MUTT_CA_HOST = 1, MUTT_CA_LOGIN, MUTT_CA_USER, MUTT_CA_PASS,
  MUTT_CA_OAUTH_CMD
}
 Login credentials. More...
 

Functions

int mutt_account_getlogin (struct ConnAccount *account)
 Retrieve login info into ConnAccount, if necessary. More...
 
char * mutt_account_getoauthbearer (struct ConnAccount *account)
 Get an OAUTHBEARER token. More...
 
int mutt_account_getpass (struct ConnAccount *account)
 Fetch password into ConnAccount, if necessary. More...
 
int mutt_account_getuser (struct ConnAccount *account)
 Retrieve username into ConnAccount, if necessary. More...
 
void mutt_account_unsetpass (struct ConnAccount *account)
 Unset ConnAccount's password. More...
 

Detailed Description

Connection Credentials.

Authors
  • Brendan Cully

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file connaccount.h.

Macro Definition Documentation

◆ MUTT_ACCT_NO_FLAGS

#define MUTT_ACCT_NO_FLAGS   0

No flags are set.

Definition at line 41 of file connaccount.h.

◆ MUTT_ACCT_PORT

#define MUTT_ACCT_PORT   (1 << 0)

Port field has been set.

Definition at line 42 of file connaccount.h.

◆ MUTT_ACCT_USER

#define MUTT_ACCT_USER   (1 << 1)

User field has been set.

Definition at line 43 of file connaccount.h.

◆ MUTT_ACCT_LOGIN

#define MUTT_ACCT_LOGIN   (1 << 2)

Login field has been set.

Definition at line 44 of file connaccount.h.

◆ MUTT_ACCT_PASS

#define MUTT_ACCT_PASS   (1 << 3)

Password field has been set.

Definition at line 45 of file connaccount.h.

◆ MUTT_ACCT_SSL

#define MUTT_ACCT_SSL   (1 << 4)

Account uses SSL/TLS.

Definition at line 46 of file connaccount.h.

Typedef Documentation

◆ MuttAccountFlags

typedef uint8_t MuttAccountFlags

Flags, Which ConnAccount fields are initialised, e.g. MUTT_ACCT_PORT.

Definition at line 40 of file connaccount.h.

Enumeration Type Documentation

◆ ConnAccountField

Login credentials.

Enumerator
MUTT_CA_HOST 

Server name.

MUTT_CA_LOGIN 

Login name.

MUTT_CA_USER 

User name.

MUTT_CA_PASS 

Password.

MUTT_CA_OAUTH_CMD 

OAuth refresh command.

Definition at line 31 of file connaccount.h.

32 {
33  MUTT_CA_HOST = 1,
35  MUTT_CA_USER,
36  MUTT_CA_PASS,
38 };
Password.
Definition: connaccount.h:36
User name.
Definition: connaccount.h:35
OAuth refresh command.
Definition: connaccount.h:37
Login name.
Definition: connaccount.h:34
Server name.
Definition: connaccount.h:33

Function Documentation

◆ mutt_account_getlogin()

int mutt_account_getlogin ( struct ConnAccount cac)

Retrieve login info into ConnAccount, if necessary.

Parameters
cacConnAccount to fill
Return values
0Success
-1Failure

Definition at line 81 of file connaccount.c.

82 {
83  if (cac->flags & MUTT_ACCT_LOGIN)
84  return 0;
85  if (!cac->get_field)
86  return -1;
87 
88  const char *login = cac->get_field(MUTT_CA_LOGIN, cac->gf_data);
89  if (!login && (mutt_account_getuser(cac) == 0))
90  {
91  login = cac->user;
92  }
93 
94  if (!login)
95  {
96  mutt_debug(LL_DEBUG1, "Couldn't get user info\n");
97  return -1;
98  }
99 
100  mutt_str_copy(cac->login, login, sizeof(cac->login));
101  cac->flags |= MUTT_ACCT_LOGIN;
102  return 0;
103 }
char login[128]
Login name.
Definition: connaccount.h:54
int mutt_account_getuser(struct ConnAccount *cac)
Retrieve username into ConnAccount, if necessary.
Definition: connaccount.c:48
char user[128]
Username.
Definition: connaccount.h:55
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Function to get some login credentials.
Definition: connaccount.h:67
void * gf_data
Private data to pass to get_field()
Definition: connaccount.h:69
#define MUTT_ACCT_LOGIN
Login field has been set.
Definition: connaccount.h:44
Log at debug level 1.
Definition: logging.h:40
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:716
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
Login name.
Definition: connaccount.h:34
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:59
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_account_getoauthbearer()

char* mutt_account_getoauthbearer ( struct ConnAccount cac)

Get an OAUTHBEARER token.

Parameters
cacAccount to use
Return values
ptrOAuth token
NULLError

Run an external command to generate the oauth refresh token for an account, then create and encode the OAUTHBEARER token based on RFC7628.

Note
Caller should free the token

Definition at line 158 of file connaccount.c.

159 {
160  if (!cac || !cac->get_field)
161  return NULL;
162 
163  /* The oauthbearer token includes the login */
164  if (mutt_account_getlogin(cac))
165  return NULL;
166 
167  const char *cmd = cac->get_field(MUTT_CA_OAUTH_CMD, cac->gf_data);
168  if (!cmd)
169  {
170  /* L10N: You will see this error message if (1) you have "oauthbearer" in
171  one of your $*_authenticators and (2) you do not have the corresponding
172  $*_oauth_refresh_command defined. So the message does not mean "None of
173  your $*_oauth_refresh_command's are defined." */
174  mutt_error(_("No OAUTH refresh command defined"));
175  return NULL;
176  }
177 
178  FILE *fp = NULL;
179  pid_t pid = filter_create(cmd, NULL, &fp, NULL);
180  if (pid < 0)
181  {
182  mutt_perror(_("Unable to run refresh command"));
183  return NULL;
184  }
185 
186  size_t token_size = 0;
187  char *token = mutt_file_read_line(NULL, &token_size, fp, NULL, 0);
188  mutt_file_fclose(&fp);
189  filter_wait(pid);
190 
191  if (!token || (*token == '\0'))
192  {
193  mutt_error(_("Command returned empty string"));
194  FREE(&token);
195  return NULL;
196  }
197 
198  if (token_size > 512)
199  {
200  mutt_error(_("OAUTH token is too big: %ld"), token_size);
201  FREE(&token);
202  return NULL;
203  }
204 
205  char oauthbearer[1024];
206  int oalen = snprintf(oauthbearer, sizeof(oauthbearer), "n,a=%s,\001host=%s\001port=%d\001auth=Bearer %s\001\001",
207  cac->login, cac->host, cac->port, token);
208  FREE(&token);
209 
210  size_t encoded_len = oalen * 4 / 3 + 10;
211  assert(encoded_len < 1400); // Assure LGTM that we won't overflow
212 
213  char *encoded_token = mutt_mem_malloc(encoded_len);
214  mutt_b64_encode(oauthbearer, oalen, encoded_token, encoded_len);
215 
216  return encoded_token;
217 }
char login[128]
Login name.
Definition: connaccount.h:54
pid_t filter_create(const char *cmd, FILE **fp_in, FILE **fp_out, FILE **fp_err)
Set up filter program.
Definition: filter.c:206
#define mutt_perror(...)
Definition: logging.h:85
#define _(a)
Definition: message.h:28
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, int flags)
Read a line from a file.
Definition: file.c:667
char host[128]
Server to login to.
Definition: connaccount.h:53
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
size_t mutt_b64_encode(const char *in, size_t inlen, char *out, size_t outlen)
Convert raw bytes to null-terminated base64 string.
Definition: base64.c:88
unsigned short port
Port to connect to.
Definition: connaccount.h:57
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Function to get some login credentials.
Definition: connaccount.h:67
void * gf_data
Private data to pass to get_field()
Definition: connaccount.h:69
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
int mutt_account_getlogin(struct ConnAccount *cac)
Retrieve login info into ConnAccount, if necessary.
Definition: connaccount.c:81
OAuth refresh command.
Definition: connaccount.h:37
#define mutt_error(...)
Definition: logging.h:84
#define FREE(x)
Definition: memory.h:40
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:217
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_account_getpass()

int mutt_account_getpass ( struct ConnAccount cac)

Fetch password into ConnAccount, if necessary.

Parameters
cacConnAccount to fill
Return values
0Success
-1Failure

Definition at line 111 of file connaccount.c.

112 {
113  if (cac->flags & MUTT_ACCT_PASS)
114  return 0;
115  if (!cac->get_field)
116  return -1;
117 
118  const char *pass = cac->get_field(MUTT_CA_PASS, cac->gf_data);
119  if (pass)
120  mutt_str_copy(cac->pass, pass, sizeof(cac->pass));
121  else if (OptNoCurses)
122  return -1;
123  else
124  {
125  char prompt[256];
126  snprintf(prompt, sizeof(prompt), _("Password for %s@%s: "),
127  (cac->flags & MUTT_ACCT_LOGIN) ? cac->login : cac->user, cac->host);
128  cac->pass[0] = '\0';
129  if (mutt_get_password(prompt, cac->pass, sizeof(cac->pass)))
130  return -1;
131  }
132 
133  cac->flags |= MUTT_ACCT_PASS;
134  return 0;
135 }
char login[128]
Login name.
Definition: connaccount.h:54
#define mutt_get_password(msg, buf, buflen)
Definition: curs_lib.h:92
char user[128]
Username.
Definition: connaccount.h:55
#define _(a)
Definition: message.h:28
WHERE bool OptNoCurses
(pseudo) when sending in batch mode
Definition: options.h:48
Password.
Definition: connaccount.h:36
char host[128]
Server to login to.
Definition: connaccount.h:53
#define MUTT_ACCT_PASS
Password field has been set.
Definition: connaccount.h:45
char pass[256]
Password.
Definition: connaccount.h:56
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Function to get some login credentials.
Definition: connaccount.h:67
void * gf_data
Private data to pass to get_field()
Definition: connaccount.h:69
#define MUTT_ACCT_LOGIN
Login field has been set.
Definition: connaccount.h:44
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:716
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:59
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_account_getuser()

int mutt_account_getuser ( struct ConnAccount cac)

Retrieve username into ConnAccount, if necessary.

Parameters
cacConnAccount to fill
Return values
0Success
-1Failure

Definition at line 48 of file connaccount.c.

49 {
50  if (cac->flags & MUTT_ACCT_USER)
51  return 0;
52  if (!cac->get_field)
53  return -1;
54 
55  const char *user = cac->get_field(MUTT_CA_USER, cac->gf_data);
56  if (user)
57  mutt_str_copy(cac->user, user, sizeof(cac->user));
58  else if (OptNoCurses)
59  return -1;
60  else
61  {
62  /* prompt (defaults to unix username), copy into cac->user */
63  char prompt[256];
64  /* L10N: Example: Username at myhost.com */
65  snprintf(prompt, sizeof(prompt), _("Username at %s: "), cac->host);
66  mutt_str_copy(cac->user, Username, sizeof(cac->user));
67  if (mutt_get_field_unbuffered(prompt, cac->user, sizeof(cac->user), MUTT_COMP_NO_FLAGS))
68  return -1;
69  }
70 
71  cac->flags |= MUTT_ACCT_USER;
72  return 0;
73 }
char user[128]
Username.
Definition: connaccount.h:55
#define _(a)
Definition: message.h:28
WHERE bool OptNoCurses
(pseudo) when sending in batch mode
Definition: options.h:48
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:43
char host[128]
Server to login to.
Definition: connaccount.h:53
WHERE char * Username
User&#39;s login name.
Definition: mutt_globals.h:52
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:56
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Function to get some login credentials.
Definition: connaccount.h:67
void * gf_data
Private data to pass to get_field()
Definition: connaccount.h:69
User name.
Definition: connaccount.h:35
int mutt_get_field_unbuffered(const char *msg, char *buf, size_t buflen, CompletionFlags flags)
Ask the user for a string (ignoring macro buffer)
Definition: curs_lib.c:334
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:716
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:59
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_account_unsetpass()

void mutt_account_unsetpass ( struct ConnAccount cac)

Unset ConnAccount's password.

Parameters
cacConnAccount to modify

Definition at line 141 of file connaccount.c.

142 {
143  cac->flags &= ~MUTT_ACCT_PASS;
144  memset(cac->pass, 0, sizeof(cac->pass));
145 }
#define MUTT_ACCT_PASS
Password field has been set.
Definition: connaccount.h:45
char pass[256]
Password.
Definition: connaccount.h:56
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:59
+ Here is the caller graph for this function: