[thirdparty/strongswan.git] / src / libpttls / sasl / sasl_plain / sasl_plain.h

/*
 * Copyright (C) 2013 Martin Willi
 *
 * Copyright (C) secunet Security Networks AG
 *
 * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * 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.
 */

/**
 * @defgroup sasl_plain sasl_plain
 * @{ @ingroup sasl
 */

#ifndef SASL_PLAIN_H_
#define SASL_PLAIN_H_

#include <sasl/sasl_mechanism.h>

typedef struct sasl_plain_t sasl_plain_t;

/**
 * SASL Mechanism implementing PLAIN.
 */
struct sasl_plain_t {

	/**
	 * Implements sasl_mechanism_t
	 */
	sasl_mechanism_t sasl;
};

/**
 * Create a sasl_plain instance.
 *
 * @param name			name of mechanism, must be "PLAIN"
 * @param client		client identity, NULL to act as server
 * @return				mechanism implementing PLAIN, NULL on error
 */
sasl_plain_t *sasl_plain_create(char *name, identification_t *client);

#endif /** SASL_PLAIN_H_ @}*/
Commit	Line	Data
2ae0c9e6 MW	1	/*
2ae0c9e6 MW	2	* Copyright (C) 2013 Martin Willi
19ef2aec TB	3	*
19ef2aec TB	4	* Copyright (C) secunet Security Networks AG
2ae0c9e6 MW	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2 of the License, or (at your
	9	* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
	10	*
	11	* This program is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	13	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	14	* for more details.
	15	*/
	16
	17	/**
	18	* @defgroup sasl_plain sasl_plain
	19	* @{ @ingroup sasl
	20	*/
	21
	22	#ifndef SASL_PLAIN_H_
	23	#define SASL_PLAIN_H_
	24
	25	#include <sasl/sasl_mechanism.h>
	26
	27	typedef struct sasl_plain_t sasl_plain_t;
	28
	29	/**
	30	* SASL Mechanism implementing PLAIN.
	31	*/
	32	struct sasl_plain_t {
	33
	34	/**
	35	* Implements sasl_mechanism_t
	36	*/
	37	sasl_mechanism_t sasl;
	38	};
	39
	40	/**
	41	* Create a sasl_plain instance.
	42	*
	43	* @param name name of mechanism, must be "PLAIN"
	44	* @param client client identity, NULL to act as server
	45	* @return mechanism implementing PLAIN, NULL on error
	46	*/
	47	sasl_plain_t sasl_plain_create(char name, identification_t *client);
	48
	49	#endif /** SASL_PLAIN_H_ @}*/