xref: /netbsd-src/crypto/external/bsd/libsaslc/dist/include/saslc.h (revision acb231545cd20720fb19dbeb268d083f219c60a0)

/*	$NetBSD: saslc.h,v 1.5 2011/02/16 02:14:22 christos Exp $	*/

/* Copyright (c) 2010 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Mateusz Kocielski.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *	  notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *	  notice, this list of conditions and the following disclaimer in the
 *	  documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *	  must display the following acknowledgement:
 *		  This product includes software developed by the NetBSD
 *		  Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation nor the names of its
 *	  contributors may be used to endorse or promote products derived
 *	  from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.	IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SASLC_H_
#define _SASLC_H_

#include <sys/types.h>

/* properties */
#define	SASLC_PROP_AUTHCID	"AUTHCID"
#define SASLC_PROP_AUTHZID	"AUTHZID"
#define SASLC_PROP_BASE64IO	"BASE64IO"
#define SASLC_PROP_CIPHERMASK	"CIPHERMASK"
#define SASLC_PROP_DEBUG	"DEBUG"
#define SASLC_PROP_HOSTNAME	"HOSTNAME"
#define SASLC_PROP_MAXBUF	"MAXBUF"
#define SASLC_PROP_PASSWD	"PASSWD"
#define SASLC_PROP_QOPMASK	"QOPMASK"
#define SASLC_PROP_REALM	"REALM"
#define SASLC_PROP_SECURITY	"SECURITY"
#define SASLC_PROP_SERVICE	"SERVICE"
#define SASLC_PROP_SERVNAME	"SERVNAME"

/* environment variables */
#define SASLC_ENV_CONFIG	"SASLC_CONFIG"
#define SASLC_ENV_DEBUG		"SASLC_DEBUG"

/* opaque types */
typedef struct saslc_t saslc_t;
typedef struct saslc_sess_t saslc_sess_t;

/* begin and end */
saslc_t *saslc_alloc(void);
int saslc_init(saslc_t *, const char *, const char *);
int saslc_end(saslc_t *);

/* error */
const char *saslc_strerror(saslc_t *);
const char *saslc_sess_strerror(saslc_sess_t *);

/* session begin and end */
saslc_sess_t *saslc_sess_init(saslc_t *, const char *, const char *);
void saslc_sess_end(saslc_sess_t *);

/* session properties */
int saslc_sess_setprop(saslc_sess_t *, const char *, const char *);
const char *saslc_sess_getprop(saslc_sess_t *, const char *);
const char *saslc_sess_getmech(saslc_sess_t *);

/* session management */
int saslc_sess_cont(saslc_sess_t *, const void *, size_t, void **, size_t *);
ssize_t saslc_sess_encode(saslc_sess_t *, const void *, size_t, void **,
    size_t *);
ssize_t saslc_sess_decode(saslc_sess_t *, const void *, size_t, void **,
    size_t *);

#endif /* ! _SASLC_H_ */