NeoMutt  2022-04-29-81-g9c5a59
Teaching an old dog new tricks
DOXYGEN
connaccount.h File Reference

Connection Credentials. More...

#include <stdbool.h>
#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, bool xoauth2)
 Get an OAUTHBEARER/XOAUTH2 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 42 of file connaccount.h.

◆ MUTT_ACCT_PORT

#define MUTT_ACCT_PORT   (1 << 0)

Port field has been set.

Definition at line 43 of file connaccount.h.

◆ MUTT_ACCT_USER

#define MUTT_ACCT_USER   (1 << 1)

User field has been set.

Definition at line 44 of file connaccount.h.

◆ MUTT_ACCT_LOGIN

#define MUTT_ACCT_LOGIN   (1 << 2)

Login field has been set.

Definition at line 45 of file connaccount.h.

◆ MUTT_ACCT_PASS

#define MUTT_ACCT_PASS   (1 << 3)

Password field has been set.

Definition at line 46 of file connaccount.h.

◆ MUTT_ACCT_SSL

#define MUTT_ACCT_SSL   (1 << 4)

Account uses SSL/TLS.

Definition at line 47 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 41 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 32 of file connaccount.h.

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

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 98 of file connaccount.c.

99 {
100  if (cac->flags & MUTT_ACCT_LOGIN)
101  return 0;
102  if (!cac->get_field)
103  return -1;
104 
105  const char *login = cac->get_field(MUTT_CA_LOGIN, cac->gf_data);
106  if (!login && (mutt_account_getuser(cac) == 0))
107  {
108  login = cac->user;
109  }
110 
111  if (!login)
112  {
113  mutt_debug(LL_DEBUG1, "Couldn't get user info\n");
114  return -1;
115  }
116 
117  mutt_str_copy(cac->login, login, sizeof(cac->login));
118  cac->flags |= MUTT_ACCT_LOGIN;
119  return 0;
120 }
int mutt_account_getuser(struct ConnAccount *cac)
Retrieve username into ConnAccount, if necessary.
Definition: connaccount.c:49
#define MUTT_ACCT_LOGIN
Login field has been set.
Definition: connaccount.h:45
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_DEBUG1
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:629
char login[128]
Login name.
Definition: connaccount.h:55
char user[128]
Username.
Definition: connaccount.h:56
const char *(* get_field)(enum ConnAccountField field, void *gf_data)
Function to get some login credentials.
Definition: connaccount.h:68
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:60
void * gf_data
Private data to pass to get_field()
Definition: connaccount.h:70
+ 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,
bool  xoauth2 
)

Get an OAUTHBEARER/XOAUTH2 token.

Parameters
cacAccount to use
xoauth2Generate a deprecated XOAUTH2 token
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 192 of file connaccount.c.

193 {
194  if (!cac || !cac->get_field)
195  return NULL;
196 
197  /* The oauthbearer token includes the login */
198  if (mutt_account_getlogin(cac))
199  return NULL;
200 
201  const char *cmd = cac->get_field(MUTT_CA_OAUTH_CMD, cac->gf_data);
202  if (!cmd)
203  {
204  /* L10N: You will see this error message if (1) you have "oauthbearer" in
205  one of your $*_authenticators and (2) you do not have the corresponding
206  $*_oauth_refresh_command defined. So the message does not mean "None of
207  your $*_oauth_refresh_command's are defined." */
208  mutt_error(_("No OAUTH refresh command defined"));
209  return NULL;
210  }
211 
212  FILE *fp = NULL;
213  pid_t pid = filter_create(cmd, NULL, &fp, NULL);
214  if (pid < 0)
215  {
216  mutt_perror(_("Unable to run refresh command"));
217  return NULL;
218  }
219 
220  size_t token_size = 0;
221  char *token = mutt_file_read_line(NULL, &token_size, fp, NULL, MUTT_RL_NO_FLAGS);
222  mutt_file_fclose(&fp);
223  filter_wait(pid);
224 
225  /* The refresh cmd in some cases will invoke gpg to decrypt a token */
226  if (!OptNoCurses)
228 
229  if (!token || (*token == '\0'))
230  {
231  mutt_error(_("Command returned empty string"));
232  FREE(&token);
233  return NULL;
234  }
235 
236  if ((!xoauth2 && (token_size > 512)) || (xoauth2 && (token_size > 4096)))
237  {
238  mutt_error(_("OAUTH token is too big: %ld"), token_size);
239  FREE(&token);
240  return NULL;
241  }
242 
243  /* 4500 is chosen to allow for both a token that is 4096-long plus a
244  * username that can be up to 320-long. */
245  char oauthbearer[4500];
246  int oalen = 0;
247  if (xoauth2)
248  {
249  oalen = snprintf(oauthbearer, sizeof(oauthbearer),
250  "user=%s\001auth=Bearer %s\001\001", cac->login, token);
251  }
252  else
253  {
254  oalen = snprintf(oauthbearer, sizeof(oauthbearer),
255  "n,a=%s,\001host=%s\001port=%d\001auth=Bearer %s\001\001",
256  cac->login, cac->host, cac->port, token);
257  }
258  FREE(&token);
259 
260  size_t encoded_len = oalen * 4 / 3 + 10;
261  assert(encoded_len < 6010); // Assure LGTM that we won't overflow
262 
263  char *encoded_token = mutt_mem_malloc(encoded_len);
264  mutt_b64_encode(oauthbearer, oalen, encoded_token, encoded_len);
265 
266  return encoded_token;
267 }
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
int mutt_account_getlogin(struct ConnAccount *cac)
Retrieve login info into ConnAccount, if necessary.
Definition: connaccount.c:98
void mutt_need_hard_redraw(void)
Force a hard refresh.
Definition: curs_lib.c:178
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:720
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:38
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:217
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_error(...)
Definition: logging.h:87
#define mutt_perror(...)
Definition: logging.h:88
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
#define FREE(x)
Definition: memory.h:40
#define _(a)
Definition: message.h:28
bool OptNoCurses
(pseudo) when sending in batch mode
Definition: options.h:53
char host[128]
Server to login to.
Definition: connaccount.h:54
unsigned short port
Port to connect to.
Definition: connaccount.h:58
+ 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 128 of file connaccount.c.

129 {
130  if (cac->flags & MUTT_ACCT_PASS)
131  return 0;
132  if (!cac->get_field)
133  return -1;
134 
135  const char *pass = cac->get_field(MUTT_CA_PASS, cac->gf_data);
136  if (pass)
137  {
138  mutt_str_copy(cac->pass, pass, sizeof(cac->pass));
139  }
141  {
142  /* The external command might interact with the screen */
143  if (!OptNoCurses)
145  return 0;
146  }
147  else if (OptNoCurses)
148  {
149  return -1;
150  }
151  else
152  {
153  char prompt[256];
154  snprintf(prompt, sizeof(prompt), _("Password for %s@%s: "),
155  (cac->flags & MUTT_ACCT_LOGIN) ? cac->login : cac->user, cac->host);
156  cac->pass[0] = '\0';
157 
158  struct Buffer *buf = mutt_buffer_pool_get();
159  const int rc = mutt_get_field_unbuffered(prompt, buf, MUTT_COMP_PASS);
160  mutt_str_copy(cac->pass, mutt_buffer_string(buf), sizeof(cac->pass));
162  if (rc != 0)
163  return -1;
164  }
165 
166  cac->flags |= MUTT_ACCT_PASS;
167  return 0;
168 }
MuttAccountFlags mutt_account_call_external_cmd(struct ConnAccount *cac)
Retrieve account credentials via an external command.
Definition: accountcmd.c:163
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
#define MUTT_ACCT_NO_FLAGS
No flags are set.
Definition: connaccount.h:42
#define MUTT_ACCT_PASS
Password field has been set.
Definition: connaccount.h:46
int mutt_get_field_unbuffered(const char *msg, struct Buffer *buf, CompletionFlags flags)
Ask the user for a string (ignoring macro buffer)
Definition: curs_lib.c:402
#define MUTT_COMP_PASS
Password mode (no echo)
Definition: mutt.h:63
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
String manipulation buffer.
Definition: buffer.h:34
char pass[256]
Password.
Definition: connaccount.h:57
+ 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 49 of file connaccount.c.

50 {
51  if (cac->flags & MUTT_ACCT_USER)
52  return 0;
53  if (!cac->get_field)
54  return -1;
55 
56  const char *user = cac->get_field(MUTT_CA_USER, cac->gf_data);
57  if (user)
58  {
59  mutt_str_copy(cac->user, user, sizeof(cac->user));
60  }
62  {
63  /* The external command might interact with the screen */
64  if (!OptNoCurses)
66  return 0;
67  }
68  else if (OptNoCurses)
69  {
70  return -1;
71  }
72  else
73  {
74  /* prompt (defaults to unix username), copy into cac->user */
75  char prompt[256];
76  /* L10N: Example: Username at myhost.com */
77  snprintf(prompt, sizeof(prompt), _("Username at %s: "), cac->host);
78  mutt_str_copy(cac->user, Username, sizeof(cac->user));
79 
80  struct Buffer *buf = mutt_buffer_pool_get();
81  const int rc = mutt_get_field_unbuffered(prompt, buf, MUTT_COMP_NO_FLAGS);
82  mutt_str_copy(cac->user, mutt_buffer_string(buf), sizeof(cac->user));
84  if (rc != 0)
85  return -1;
86  }
87 
88  cac->flags |= MUTT_ACCT_USER;
89  return 0;
90 }
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:44
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:52
char * Username
User's login name.
Definition: mutt_globals.h:52
+ 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 174 of file connaccount.c.

175 {
176  cac->flags &= ~MUTT_ACCT_PASS;
177  memset(cac->pass, 0, sizeof(cac->pass));
178 }
+ Here is the caller graph for this function: