sasl_plain.h File Reference

SASL plain authentication support. More...

#include <stdlib.h>

Include dependency graph for sasl_plain.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
size_t	mutt_sasl_plain_msg (struct Buffer *buf, const char *cmd, const char *authz, const char *user, const char *pass)
	Construct a base64 encoded SASL PLAIN message.

Detailed Description

SASL plain authentication support.

Authors

• Pietro Cerutti
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 sasl_plain.h.

Function Documentation

mutt_sasl_plain_msg()

size_t mutt_sasl_plain_msg	(	struct Buffer *	buf,
		const char *	cmd,
		const char *	authz,
		const char *	user,
		const char *	pass
	)

Construct a base64 encoded SASL PLAIN message.

Parameters

buf	Destination buffer
cmd	Protocol-specific string the prepend to the PLAIN message
authz	Authorization identity
user	Authentication identity (username)
pass	Password

Return values

>0	Success, number of chars in the command string
0	Error

This function can be used to build a protocol-specific SASL Response message using the PLAIN mechanism. The protocol specific command is given in the cmd parameter. The function appends a space, encodes the string derived from authz\0user\0pass using base64 encoding, and stores the result in buf. If cmd is either NULL or the empty string, the initial space is skipped.

Definition at line 50 of file sasl_plain.c.

{
  if (!user || (*user == '\0') || !pass || (*pass == '\0'))
    return 0;
 
  if (cmd && (*cmd != '\0'))
    buf_printf(buf, "%s ", cmd);
 
  struct Buffer *user_pass = buf_pool_get();
  struct Buffer *encoded = buf_pool_get();
 
  buf_printf(user_pass, "%s%c%s%c%s", NONULL(authz), '\0', user, '\0', pass);
  mutt_b64_buffer_encode(encoded, buf_string(user_pass), buf_len(user_pass));
  buf_addstr(buf, buf_string(encoded));
 
  buf_pool_release(&user_pass);
  buf_pool_release(&encoded);
 
  return buf_len(buf);
}

Here is the call graph for this function:

Here is the caller graph for this function: