sasl.h File Reference

SASL secure transport layer. More...

#include <proton/import_export.h>
#include <proton/type_compat.h>
#include <proton/types.h>

Go to the source code of this file.

Typedefs
typedef struct pn_sasl_t	pn_sasl_t
	The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over which AMQP frames are passed between peers.

Enumerations
enum	pn_sasl_outcome_t {   PN_SASL_NONE , PN_SASL_OK , PN_SASL_AUTH , PN_SASL_SYS ,   PN_SASL_PERM , PN_SASL_TEMP }
	The result of the SASL negotiation. More...

Functions
pn_sasl_t *	pn_sasl (pn_transport_t *transport)
	Construct an Authentication and Security Layer object.
bool	pn_sasl_extended (void)
	Do we support extended SASL negotiation.
void	pn_sasl_done (pn_sasl_t *sasl, pn_sasl_outcome_t outcome)
	Deprecated - Do not use.
pn_sasl_outcome_t	pn_sasl_outcome (pn_sasl_t *sasl)
	Retrieve the outcome of SASL negotiation.
const char *	pn_sasl_get_user (pn_sasl_t *sasl)
	Retrieve the authenticated user.
const char *	pn_sasl_get_authorization (pn_sasl_t *sasl)
	Retrieve the authorization id.
const char *	pn_sasl_get_mech (pn_sasl_t *sasl)
	Return the selected SASL mechanism.
void	pn_sasl_allowed_mechs (pn_sasl_t *sasl, const char *mechs)
	SASL mechanisms that are to be considered for authentication.
void	pn_sasl_set_allow_insecure_mechs (pn_sasl_t *sasl, bool insecure)
	Boolean to allow use of clear text authentication mechanisms.
bool	pn_sasl_get_allow_insecure_mechs (pn_sasl_t *sasl)
	Return the current value for allow_insecure_mechs.
void	pn_sasl_config_name (pn_sasl_t *sasl, const char *name)
	Set the sasl configuration name.
void	pn_sasl_config_path (pn_sasl_t *sasl, const char *path)
	Set the sasl configuration path.

Detailed Description

SASL secure transport layer.