xref: /minix3/crypto/external/bsd/libsaslc/dist/include/saslc.h (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc /*	$NetBSD: saslc.h,v 1.5 2011/02/16 02:14:22 christos Exp $	*/
2*ebfedea0SLionel Sambuc 
3*ebfedea0SLionel Sambuc /* Copyright (c) 2010 The NetBSD Foundation, Inc.
4*ebfedea0SLionel Sambuc  * All rights reserved.
5*ebfedea0SLionel Sambuc  *
6*ebfedea0SLionel Sambuc  * This code is derived from software contributed to The NetBSD Foundation
7*ebfedea0SLionel Sambuc  * by Mateusz Kocielski.
8*ebfedea0SLionel Sambuc  *
9*ebfedea0SLionel Sambuc  * Redistribution and use in source and binary forms, with or without
10*ebfedea0SLionel Sambuc  * modification, are permitted provided that the following conditions
11*ebfedea0SLionel Sambuc  * are met:
12*ebfedea0SLionel Sambuc  * 1. Redistributions of source code must retain the above copyright
13*ebfedea0SLionel Sambuc  *	  notice, this list of conditions and the following disclaimer.
14*ebfedea0SLionel Sambuc  * 2. Redistributions in binary form must reproduce the above copyright
15*ebfedea0SLionel Sambuc  *	  notice, this list of conditions and the following disclaimer in the
16*ebfedea0SLionel Sambuc  *	  documentation and/or other materials provided with the distribution.
17*ebfedea0SLionel Sambuc  * 3. All advertising materials mentioning features or use of this software
18*ebfedea0SLionel Sambuc  *	  must display the following acknowledgement:
19*ebfedea0SLionel Sambuc  *		  This product includes software developed by the NetBSD
20*ebfedea0SLionel Sambuc  *		  Foundation, Inc. and its contributors.
21*ebfedea0SLionel Sambuc  * 4. Neither the name of The NetBSD Foundation nor the names of its
22*ebfedea0SLionel Sambuc  *	  contributors may be used to endorse or promote products derived
23*ebfedea0SLionel Sambuc  *	  from this software without specific prior written permission.
24*ebfedea0SLionel Sambuc  *
25*ebfedea0SLionel Sambuc  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26*ebfedea0SLionel Sambuc  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27*ebfedea0SLionel Sambuc  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28*ebfedea0SLionel Sambuc  * PURPOSE ARE DISCLAIMED.	IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29*ebfedea0SLionel Sambuc  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30*ebfedea0SLionel Sambuc  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31*ebfedea0SLionel Sambuc  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32*ebfedea0SLionel Sambuc  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33*ebfedea0SLionel Sambuc  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34*ebfedea0SLionel Sambuc  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35*ebfedea0SLionel Sambuc  * POSSIBILITY OF SUCH DAMAGE.
36*ebfedea0SLionel Sambuc  */
37*ebfedea0SLionel Sambuc 
38*ebfedea0SLionel Sambuc #ifndef _SASLC_H_
39*ebfedea0SLionel Sambuc #define _SASLC_H_
40*ebfedea0SLionel Sambuc 
41*ebfedea0SLionel Sambuc #include <sys/types.h>
42*ebfedea0SLionel Sambuc 
43*ebfedea0SLionel Sambuc /* properties */
44*ebfedea0SLionel Sambuc #define	SASLC_PROP_AUTHCID	"AUTHCID"
45*ebfedea0SLionel Sambuc #define SASLC_PROP_AUTHZID	"AUTHZID"
46*ebfedea0SLionel Sambuc #define SASLC_PROP_BASE64IO	"BASE64IO"
47*ebfedea0SLionel Sambuc #define SASLC_PROP_CIPHERMASK	"CIPHERMASK"
48*ebfedea0SLionel Sambuc #define SASLC_PROP_DEBUG	"DEBUG"
49*ebfedea0SLionel Sambuc #define SASLC_PROP_HOSTNAME	"HOSTNAME"
50*ebfedea0SLionel Sambuc #define SASLC_PROP_MAXBUF	"MAXBUF"
51*ebfedea0SLionel Sambuc #define SASLC_PROP_PASSWD	"PASSWD"
52*ebfedea0SLionel Sambuc #define SASLC_PROP_QOPMASK	"QOPMASK"
53*ebfedea0SLionel Sambuc #define SASLC_PROP_REALM	"REALM"
54*ebfedea0SLionel Sambuc #define SASLC_PROP_SECURITY	"SECURITY"
55*ebfedea0SLionel Sambuc #define SASLC_PROP_SERVICE	"SERVICE"
56*ebfedea0SLionel Sambuc #define SASLC_PROP_SERVNAME	"SERVNAME"
57*ebfedea0SLionel Sambuc 
58*ebfedea0SLionel Sambuc /* environment variables */
59*ebfedea0SLionel Sambuc #define SASLC_ENV_CONFIG	"SASLC_CONFIG"
60*ebfedea0SLionel Sambuc #define SASLC_ENV_DEBUG		"SASLC_DEBUG"
61*ebfedea0SLionel Sambuc 
62*ebfedea0SLionel Sambuc /* opaque types */
63*ebfedea0SLionel Sambuc typedef struct saslc_t saslc_t;
64*ebfedea0SLionel Sambuc typedef struct saslc_sess_t saslc_sess_t;
65*ebfedea0SLionel Sambuc 
66*ebfedea0SLionel Sambuc /* begin and end */
67*ebfedea0SLionel Sambuc saslc_t *saslc_alloc(void);
68*ebfedea0SLionel Sambuc int saslc_init(saslc_t *, const char *, const char *);
69*ebfedea0SLionel Sambuc int saslc_end(saslc_t *);
70*ebfedea0SLionel Sambuc 
71*ebfedea0SLionel Sambuc /* error */
72*ebfedea0SLionel Sambuc const char *saslc_strerror(saslc_t *);
73*ebfedea0SLionel Sambuc const char *saslc_sess_strerror(saslc_sess_t *);
74*ebfedea0SLionel Sambuc 
75*ebfedea0SLionel Sambuc /* session begin and end */
76*ebfedea0SLionel Sambuc saslc_sess_t *saslc_sess_init(saslc_t *, const char *, const char *);
77*ebfedea0SLionel Sambuc void saslc_sess_end(saslc_sess_t *);
78*ebfedea0SLionel Sambuc 
79*ebfedea0SLionel Sambuc /* session properties */
80*ebfedea0SLionel Sambuc int saslc_sess_setprop(saslc_sess_t *, const char *, const char *);
81*ebfedea0SLionel Sambuc const char *saslc_sess_getprop(saslc_sess_t *, const char *);
82*ebfedea0SLionel Sambuc const char *saslc_sess_getmech(saslc_sess_t *);
83*ebfedea0SLionel Sambuc 
84*ebfedea0SLionel Sambuc /* session management */
85*ebfedea0SLionel Sambuc int saslc_sess_cont(saslc_sess_t *, const void *, size_t, void **, size_t *);
86*ebfedea0SLionel Sambuc ssize_t saslc_sess_encode(saslc_sess_t *, const void *, size_t, void **,
87*ebfedea0SLionel Sambuc     size_t *);
88*ebfedea0SLionel Sambuc ssize_t saslc_sess_decode(saslc_sess_t *, const void *, size_t, void **,
89*ebfedea0SLionel Sambuc     size_t *);
90*ebfedea0SLionel Sambuc 
91*ebfedea0SLionel Sambuc #endif /* ! _SASLC_H_ */
92