1 /* saslplug.h -- API for SASL plug-ins
24 /* callback to lookup a sasl_callback_t for a connection
26 * conn -- the connection to lookup a callback for
27 * callbacknum -- the number of the callback
29 * pproc -- pointer to the callback function (set to NULL on failure)
30 * pcontext -- pointer to the callback context (set to NULL on failure)
33 * SASL_FAIL -- unable to find a callback of the requested type
34 * SASL_INTERACT -- caller must use interaction to get data
36 typedef int sasl_getcallback_t(sasl_conn_t *conn,
37 unsigned long callbackid,
41 /* The sasl_utils structure will remain backwards compatible unless
42 * the SASL_*_PLUG_VERSION is changed incompatibly
43 * higher SASL_UTILS_VERSION numbers indicate more functions are available
45 #define SASL_UTILS_VERSION 4
47 /* utility function set for plug-ins
49 typedef struct sasl_utils {
58 sasl_getopt_t *getopt;
60 /* allocation functions: */
61 sasl_malloc_t *malloc;
62 sasl_calloc_t *calloc;
63 sasl_realloc_t *realloc;
66 /* mutex functions: */
67 sasl_mutex_alloc_t *mutex_alloc;
68 sasl_mutex_lock_t *mutex_lock;
69 sasl_mutex_unlock_t *mutex_unlock;
70 sasl_mutex_free_t *mutex_free;
72 /* MD5 hash and HMAC functions */
73 void (*MD5Init)(MD5_CTX *);
74 void (*MD5Update)(MD5_CTX *, const unsigned char *text, unsigned int len);
75 void (*MD5Final)(unsigned char [16], MD5_CTX *);
76 void (*hmac_md5)(const unsigned char *text, int text_len,
77 const unsigned char *key, int key_len,
79 void (*hmac_md5_init)(HMAC_MD5_CTX *, const unsigned char *key, int len);
80 /* hmac_md5_update() is just a call to MD5Update on inner context */
81 void (*hmac_md5_final)(unsigned char [16], HMAC_MD5_CTX *);
82 void (*hmac_md5_precalc)(HMAC_MD5_STATE *,
83 const unsigned char *key, int len);
84 void (*hmac_md5_import)(HMAC_MD5_CTX *, HMAC_MD5_STATE *);
86 /* mechanism utility functions (same as above): */
87 int (*mkchal)(sasl_conn_t *conn, char *buf, unsigned maxlen,
89 int (*utf8verify)(const char *str, unsigned len);
90 void (*rand)(sasl_rand_t *rpool, char *buf, unsigned len);
91 void (*churn)(sasl_rand_t *rpool, const char *data, unsigned len);
93 /* This allows recursive calls to the sasl_checkpass() routine from
94 * within a SASL plug-in. This MUST NOT be used in the PLAIN mechanism
95 * as sasl_checkpass MAY be a front-end for the PLAIN mechanism.
96 * This is intended for use by the non-standard LOGIN mechanism and
97 * potentially by a future mechanism which uses public-key technology to
98 * set up a lightweight encryption layer just for sending a password.
100 int (*checkpass)(sasl_conn_t *conn,
101 const char *user, unsigned userlen,
102 const char *pass, unsigned passlen);
104 /* Access to base64 encode/decode routines */
105 int (*decode64)(const char *in, unsigned inlen,
106 char *out, unsigned outmax, unsigned *outlen);
107 int (*encode64)(const char *in, unsigned inlen,
108 char *out, unsigned outmax, unsigned *outlen);
111 void (*erasebuffer)(char *buf, unsigned len);
113 /* callback to sasl_getprop() and sasl_setprop() */
114 int (*getprop)(sasl_conn_t *conn, int propnum, const void **pvalue);
115 int (*setprop)(sasl_conn_t *conn, int propnum, const void *value);
117 /* callback function */
118 sasl_getcallback_t *getcallback;
120 /* format a message and then pass it to the SASL_CB_LOG callback
122 * use syslog()-style formatting (printf with %m as a human readable text
123 * (strerror()) for the error specified as the parameter).
124 * The implementation may use a fixed size buffer not smaller
125 * than 512 octets if it securely truncates the message.
127 * level is a SASL_LOG_* level (see sasl.h)
129 void (*log)(sasl_conn_t *conn, int level, const char *fmt, ...);
131 /* callback to sasl_seterror() */
132 void (*seterror)(sasl_conn_t *conn, unsigned flags, const char *fmt, ...);
134 /* spare function pointer */
135 int *(*spare_fptr)();
137 /* auxiliary property utilities */
138 struct propctx *(*prop_new)(unsigned estimate);
139 int (*prop_dup)(struct propctx *src_ctx, struct propctx **dst_ctx);
140 int (*prop_request)(struct propctx *ctx, const char **names);
141 const struct propval *(*prop_get)(struct propctx *ctx);
142 int (*prop_getnames)(struct propctx *ctx, const char **names,
143 struct propval *vals);
144 void (*prop_clear)(struct propctx *ctx, int requests);
145 void (*prop_dispose)(struct propctx **ctx);
146 int (*prop_format)(struct propctx *ctx, const char *sep, int seplen,
147 char *outbuf, unsigned outmax, unsigned *outlen);
148 int (*prop_set)(struct propctx *ctx, const char *name,
149 const char *value, int vallen);
150 int (*prop_setvals)(struct propctx *ctx, const char *name,
151 const char **values);
152 void (*prop_erase)(struct propctx *ctx, const char *name);
153 int (*auxprop_store)(sasl_conn_t *conn,
154 struct propctx *ctx, const char *user);
156 /* for additions which don't require a version upgrade; set to 0 */
157 int (*spare_fptr1)();
158 int (*spare_fptr2)();
162 * output parameters from SASL API
164 * created / destroyed by the glue code, though probably filled in
165 * by a combination of the plugin, the glue code, and the canon_user callback.
168 typedef struct sasl_out_params {
169 unsigned doneflag; /* exchange complete */
171 const char *user; /* canonicalized user name */
172 const char *authid; /* canonicalized authentication id */
174 unsigned ulen; /* length of canonicalized user name */
175 unsigned alen; /* length of canonicalized authid */
177 /* security layer information */
178 unsigned maxoutbuf; /* Maximum buffer size, which will
179 produce buffer no bigger than the
180 negotiated SASL maximum buffer size */
181 sasl_ssf_t mech_ssf; /* Should be set non-zero if negotiation of a
182 * security layer was *attempted*, even if
183 * the negotiation failed */
184 void *encode_context;
185 int (*encode)(void *context, const struct iovec *invec, unsigned numiov,
186 const char **output, unsigned *outputlen);
187 void *decode_context;
188 int (*decode)(void *context, const char *input, unsigned inputlen,
189 const char **output, unsigned *outputlen);
191 /* Pointer to delegated (client's) credentials, if supported by
192 the SASL mechanism */
195 /* for additions which don't require a version upgrade; set to 0 */
197 void *gss_local_name;
199 int (*spare_fptr1)();
200 int (*spare_fptr2)();
206 /* set to 0 initially, this allows a plugin with extended parameters
207 * to work with an older framework by updating version as parameters
215 /* Used by both client and server side plugins */
217 SASL_INFO_LIST_START = 0,
220 } sasl_info_callback_stage_t;
224 /******************************
225 * Client Mechanism Functions *
226 ******************************/
229 * input parameters to client SASL plugin
231 * created / destroyed by the glue code
234 typedef struct sasl_client_params {
235 const char *service; /* service name */
236 const char *serverFQDN; /* server fully qualified domain name */
237 const char *clientFQDN; /* client's fully qualified domain name */
238 const sasl_utils_t *utils; /* SASL API utility routines --
239 * for a particular sasl_conn_t,
240 * MUST remain valid until mech_free is
242 const sasl_callback_t *prompt_supp; /* client callback list */
243 const char *iplocalport; /* server IP domain literal & port */
244 const char *ipremoteport; /* client IP domain literal & port */
246 unsigned servicelen; /* length of service */
247 unsigned slen; /* length of serverFQDN */
248 unsigned clen; /* length of clientFQDN */
249 unsigned iploclen; /* length of iplocalport */
250 unsigned ipremlen; /* length of ipremoteport */
252 /* application's security requirements & info */
253 sasl_security_properties_t props;
254 sasl_ssf_t external_ssf; /* external SSF active */
256 /* for additions which don't require a version upgrade; set to 0 */
258 void *chanbindingstype;
259 void *chanbindingsdata;
260 struct sasl_client_plug *plug;
262 /* Canonicalize a user name from on-wire to internal format
263 * added rjs3 2001-05-23
264 * Must be called once user name aquired if canon_user is non-NULL.
265 * conn connection context
266 * in user name from wire protocol (need not be NUL terminated)
267 * len length of user name from wire protocol (0 = strlen(user))
268 * flags for SASL_CU_* flags
269 * oparams the user, authid, ulen, alen, fields are
270 * set appropriately after canonicalization/copying and
271 * authorization of arguments
273 * responsible for setting user, ulen, authid, and alen in the oparams
276 * default behavior is to strip leading and trailing whitespace, as
277 * well as allocating space for and copying the parameters.
281 * SASL_NOMEM -- out of memory
282 * SASL_BADPARAM -- invalid conn
283 * SASL_BADPROT -- invalid user/authid
285 int (*canon_user)(sasl_conn_t *conn,
286 const char *in, unsigned len,
288 sasl_out_params_t *oparams);
290 int (*spare_fptr1)();
296 /* flags field as passed to sasl_client_new */
299 /* set to 0 initially, this allows a plugin with extended parameters
300 * to work with an older framework by updating version as parameters
304 } sasl_client_params_t;
306 /* features shared between client and server */
307 /* These allow the glue code to handle client-first and server-last issues */
309 /* This indicates that the mechanism prefers to do client-send-first
310 * if the protocol allows it. */
311 #define SASL_FEAT_WANT_CLIENT_FIRST 0x0002
313 /* This feature is deprecated, instead, plugins should set *serverout to
314 * non-NULL and return SASL_OK intelligently to allow flexible use of
315 * server-last semantics */
316 /* #define SASL_FEAT_WANT_SERVER_LAST 0x0004 */
318 /* This feature is deprecated, instead plugins should correctly set
319 * SASL_FEAT_SERVER_FIRST as needed */
320 /* #define SASL_FEAT_INTERNAL_CLIENT_FIRST 0x0008 */
322 /* This indicates that the plugin is server-first only.
323 * Not defining either of SASL_FEAT_SERVER_FIRST or
324 * SASL_FEAT_WANT_CLIENT_FIRST indicates that the mechanism will take care
325 * of the client-first situation internally.
327 #define SASL_FEAT_SERVER_FIRST 0x0010
329 /* This plugin allows proxying */
330 #define SASL_FEAT_ALLOWS_PROXY 0x0020
332 /* Underlying mechanism uses GSS framing */
333 #define SASL_FEAT_GSS_FRAMING 0x0040
334 /* client plug-in features */
335 #define SASL_FEAT_NEEDSERVERFQDN 0x0001
337 /* a C object for a client mechanism
339 typedef struct sasl_client_plug {
341 const char *mech_name;
343 /* best mech additional security layer strength factor */
346 /* best security flags, as defined in sasl_security_properties_t */
347 unsigned security_flags;
349 /* features of plugin */
352 /* required prompt ids, NULL = user/pass only */
353 const unsigned long *required_prompts;
355 /* global state for mechanism */
358 /* create context for mechanism, using params supplied
359 * glob_context -- from above
360 * params -- params from sasl_client_new
361 * conn_context -- context for one connection
364 * SASL_NOMEM -- not enough memory
365 * SASL_WRONGMECH -- mech doesn't support security params
367 int (*mech_new)(void *glob_context,
368 sasl_client_params_t *cparams,
369 void **conn_context);
371 /* perform one step of exchange. NULL is passed for serverin on
375 * SASL_INTERACT -- user interaction needed to fill in prompts
376 * SASL_BADPROT -- server protocol incorrect/cancelled
377 * SASL_BADSERV -- server failed mutual auth
379 int (*mech_step)(void *conn_context,
380 sasl_client_params_t *cparams,
381 const char *serverin,
382 unsigned serverinlen,
383 sasl_interact_t **prompt_need,
384 const char **clientout,
385 unsigned *clientoutlen,
386 sasl_out_params_t *oparams);
388 /* dispose of connection context from mech_new
390 void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
392 /* free all global space used by mechanism
393 * mech_dispose must be called on all mechanisms first
395 void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
397 /* perform precalculations during a network round-trip
398 * or idle period. conn_context may be NULL
399 * returns 1 if action taken, 0 if no action taken
401 int (*idle)(void *glob_context,
403 sasl_client_params_t *cparams);
405 /* for additions which don't require a version upgrade; set to 0 */
406 int (*spare_fptr1)();
407 int (*spare_fptr2)();
408 } sasl_client_plug_t;
410 #define SASL_CLIENT_PLUG_VERSION 4
412 /* plug-in entry point:
413 * utils -- utility callback functions
414 * max_version -- highest client plug version supported
416 * out_version -- client plug version of result
417 * pluglist -- list of mechanism plug-ins
418 * plugcount -- number of mechanism plug-ins
421 * SASL_NOMEM -- failure
422 * SASL_BADVERS -- max_version too small
423 * SASL_BADPARAM -- bad config string
426 typedef int sasl_client_plug_init_t(const sasl_utils_t *utils,
429 sasl_client_plug_t **pluglist,
433 /* add a client plug-in
435 LIBSASL_API int sasl_client_add_plugin(const char *plugname,
436 sasl_client_plug_init_t *cplugfunc);
438 typedef struct client_sasl_mechanism
443 const sasl_client_plug_t *plug;
444 } client_sasl_mechanism_t;
446 typedef void sasl_client_info_callback_t (client_sasl_mechanism_t *m,
447 sasl_info_callback_stage_t stage,
450 /* Dump information about available client plugins */
451 LIBSASL_API int sasl_client_plugin_info (const char *mech_list,
452 sasl_client_info_callback_t *info_cb,
456 /********************
458 ********************/
460 /* log message formatting routine */
461 typedef void sasl_logmsg_p(sasl_conn_t *conn, const char *fmt, ...);
463 struct sasl_server_plug;
466 * input parameters to server SASL plugin
468 * created / destroyed by the glue code
471 typedef struct sasl_server_params {
472 const char *service; /* NULL = default service for user_exists
474 const char *appname; /* name of calling application */
475 const char *serverFQDN; /* server default fully qualified domain name
476 * (e.g., gethostname) */
477 const char *user_realm; /* realm for user (NULL = client supplied) */
478 const char *iplocalport; /* server IP domain literal & port */
479 const char *ipremoteport; /* client IP domain literal & port */
481 unsigned servicelen; /* length of service */
482 unsigned applen; /* length of appname */
483 unsigned slen; /* length of serverFQDN */
484 unsigned urlen; /* length of user_realm */
485 unsigned iploclen; /* length of iplocalport */
486 unsigned ipremlen; /* length of ipremoteport */
488 /* This indicates the level of logging desired. See SASL_LOG_*
491 * Plug-ins can ignore this and just pass their desired level to
492 * the log callback. This is primarily used to eliminate logging which
493 * might be a performance problem (e.g., full protocol trace) and
494 * to select between SASL_LOG_TRACE and SASL_LOG_PASS alternatives
498 const sasl_utils_t *utils; /* SASL API utility routines --
499 * for a particular sasl_conn_t,
500 * MUST remain valid until mech_free is
502 const sasl_callback_t *callbacks; /* Callbacks from application */
504 /* application's security requirements */
505 sasl_security_properties_t props;
506 sasl_ssf_t external_ssf; /* external SSF active */
508 /* Pointer to the function which takes the plaintext passphrase and
509 * transitions a user to non-plaintext mechanisms via setpass calls.
510 * (NULL = auto transition not enabled/supported)
512 * If passlen is 0, it defaults to strlen(pass).
513 * returns 0 if no entry added, 1 if entry added
515 int (*transition)(sasl_conn_t *conn, const char *pass, unsigned passlen);
517 /* Canonicalize a user name from on-wire to internal format
518 * added cjn 1999-09-21
519 * Must be called once user name acquired if canon_user is non-NULL.
520 * conn connection context
521 * user user name from wire protocol (need not be NUL terminated)
522 * ulen length of user name from wire protocol (0 = strlen(user))
523 * flags for SASL_CU_* flags
524 * oparams the user, authid, ulen, alen, fields are
525 * set appropriately after canonicalization/copying and
526 * authorization of arguments
528 * responsible for setting user, ulen, authid, and alen in the oparams
531 * default behavior is to strip leading and trailing whitespace, as
532 * well as allocating space for and copying the parameters.
536 * SASL_NOMEM -- out of memory
537 * SASL_BADPARAM -- invalid conn
538 * SASL_BADPROT -- invalid user/authid
540 int (*canon_user)(sasl_conn_t *conn,
541 const char *user, unsigned ulen,
543 sasl_out_params_t *oparams);
545 /* auxiliary property context (see definitions in prop.h)
546 * added cjn 2000-01-30
548 * NOTE: these properties are the ones associated with the
549 * canonicalized "user" (user to login as / authorization id), not
550 * the "authid" (user whose credentials are used / authentication id)
551 * Prefix the property name with a "*" if a property associated with
552 * the "authid" is interesting.
554 struct propctx *propctx;
556 /* for additions which don't require a version upgrade; set to 0 */
558 void *chanbindingstype;
559 void *chanbindingsdata;
560 struct sasl_server_plug *plug;
561 int (*spare_fptr1)();
562 int (*spare_fptr2)();
567 /* flags field as passed to sasl_server_new */
570 /* set to 0 initially, this allows a plugin with extended parameters
571 * to work with an older framework by updating version as parameters
575 } sasl_server_params_t;
577 /* logging levels (more levels may be added later, if necessary):
579 #define SASL_LOG_NONE 0 /* don't log anything */
580 #define SASL_LOG_ERR 1 /* log unusual errors (default) */
581 #define SASL_LOG_FAIL 2 /* log all authentication failures */
582 #define SASL_LOG_WARN 3 /* log non-fatal warnings */
583 #define SASL_LOG_NOTE 4 /* more verbose than LOG_WARN */
584 #define SASL_LOG_DEBUG 5 /* more verbose than LOG_NOTE */
585 #define SASL_LOG_TRACE 6 /* traces of internal protocols */
586 #define SASL_LOG_PASS 7 /* traces of internal protocols, including
589 /* additional flags for setpass() function below:
591 /* SASL_SET_CREATE create user if pass non-NULL */
592 /* SASL_SET_DISABLE disable user */
593 #define SASL_SET_REMOVE SASL_SET_CREATE /* remove user if pass is NULL */
595 /* features for server plug-in
597 #define SASL_FEAT_SERVICE 0x0200 /* service-specific passwords supported */
598 #define SASL_FEAT_GETSECRET 0x0400 /* sasl_server_{get,put}secret_t callbacks
599 * required by plug-in */
601 /* a C object for a server mechanism
603 typedef struct sasl_server_plug {
605 const char *mech_name;
607 /* best mech additional security layer strength factor */
610 /* best security flags, as defined in sasl_security_properties_t */
611 unsigned security_flags;
613 /* features of plugin */
616 /* global state for mechanism */
619 /* create a new mechanism handler
620 * glob_context -- global context
621 * sparams -- server config params
622 * challenge -- server challenge from previous instance or NULL
623 * challen -- length of challenge from previous instance or 0
625 * conn_context -- connection context
626 * errinfo -- error information
629 * SASL_OK -- successfully created mech instance
630 * SASL_* -- any other server error code
632 int (*mech_new)(void *glob_context,
633 sasl_server_params_t *sparams,
634 const char *challenge,
636 void **conn_context);
638 /* perform one step in exchange
641 * SASL_OK -- success, all done
642 * SASL_CONTINUE -- success, one more round trip
643 * SASL_* -- any other server error code
645 int (*mech_step)(void *conn_context,
646 sasl_server_params_t *sparams,
647 const char *clientin,
648 unsigned clientinlen,
649 const char **serverout,
650 unsigned *serveroutlen,
651 sasl_out_params_t *oparams);
653 /* dispose of a connection state
655 void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
657 /* free global state for mechanism
658 * mech_dispose must be called on all mechanisms first
660 void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
662 /* set a password (optional)
663 * glob_context -- global context
664 * sparams -- service, middleware utilities, etc. props ignored
666 * pass -- password/passphrase (NULL = disable/remove/delete)
667 * passlen -- length of password/passphrase
668 * oldpass -- old password/passphrase (NULL = transition)
669 * oldpasslen -- length of password/passphrase
673 * SASL_NOCHANGE -- no change was needed
674 * SASL_NOUSER -- no entry for user
675 * SASL_NOVERIFY -- no mechanism compatible entry for user
676 * SASL_PWLOCK -- password locked
677 * SASL_DIABLED -- account disabled
680 int (*setpass)(void *glob_context,
681 sasl_server_params_t *sparams,
683 const char *pass, unsigned passlen,
684 const char *oldpass, unsigned oldpasslen,
687 /* query which mechanisms are available for user
688 * glob_context -- context
689 * sparams -- service, middleware utilities, etc. props ignored
690 * user -- NUL terminated user name
691 * maxmech -- max number of strings in mechlist (0 = no output)
693 * mechlist -- an array of C string pointers, filled in with
694 * mechanism names available to the user
698 * SASL_NOMEM -- not enough memory
699 * SASL_FAIL -- lower level failure
700 * SASL_DISABLED -- account disabled
701 * SASL_NOUSER -- user not found
702 * SASL_BUFOVER -- maxmech is too small
703 * SASL_NOVERIFY -- user found, but no mechanisms available
705 int (*user_query)(void *glob_context,
706 sasl_server_params_t *sparams,
709 const char **mechlist);
711 /* perform precalculations during a network round-trip
712 * or idle period. conn_context may be NULL (optional)
713 * returns 1 if action taken, 0 if no action taken
715 int (*idle)(void *glob_context,
717 sasl_server_params_t *sparams);
719 /* check if mechanism is available
720 * optional--if NULL, mechanism is available based on ENABLE= in config
722 * If this routine sets conn_context to a non-NULL value, then the call
723 * to mech_new will be skipped. This should not be done unless
724 * there's a significant performance benefit, since it can cause
725 * additional memory allocation in SASL core code to keep track of
726 * contexts potentially for multiple mechanisms.
728 * This is called by the first call to sasl_listmech() for a
729 * given connection context, thus for a given protocol it may
730 * never be called. Note that if mech_avail returns SASL_NOMECH,
731 * then that mechanism is considered disabled for the remainder
732 * of the session. If mech_avail returns SASL_NOTDONE, then a
733 * future call to mech_avail may still return either SASL_OK
736 * returns SASL_OK on success,
737 * SASL_NOTDONE if mech is not available now, but may be later
738 * (e.g. EXTERNAL w/o auth_id)
739 * SASL_NOMECH if mech disabled
741 int (*mech_avail)(void *glob_context,
742 sasl_server_params_t *sparams,
743 void **conn_context);
745 /* for additions which don't require a version upgrade; set to 0 */
746 int (*spare_fptr2)();
747 } sasl_server_plug_t;
749 #define SASL_SERVER_PLUG_VERSION 4
751 /* plug-in entry point:
752 * utils -- utility callback functions
753 * plugname -- name of plug-in (may be NULL)
754 * max_version -- highest server plug version supported
756 * out_version -- server plug-in version of result
757 * pluglist -- list of mechanism plug-ins
758 * plugcount -- number of mechanism plug-ins
761 * SASL_NOMEM -- failure
762 * SASL_BADVERS -- max_version too small
763 * SASL_BADPARAM -- bad config string
766 typedef int sasl_server_plug_init_t(const sasl_utils_t *utils,
769 sasl_server_plug_t **pluglist,
773 * add a server plug-in
775 LIBSASL_API int sasl_server_add_plugin(const char *plugname,
776 sasl_server_plug_init_t *splugfunc);
779 typedef struct server_sasl_mechanism
782 int condition; /* set to SASL_NOUSER if no available users;
783 set to SASL_CONTINUE if delayed plugin loading */
784 char *plugname; /* for AUTHSOURCE tracking */
785 const sasl_server_plug_t *plug;
786 char *f; /* where should i load the mechanism from? */
787 } server_sasl_mechanism_t;
789 typedef void sasl_server_info_callback_t (server_sasl_mechanism_t *m,
790 sasl_info_callback_stage_t stage,
794 /* Dump information about available server plugins (separate functions are
795 used for canon and auxprop plugins) */
796 LIBSASL_API int sasl_server_plugin_info (const char *mech_list,
797 sasl_server_info_callback_t *info_cb,
801 /*********************************************************
802 * user canonicalization plug-in -- added cjn 1999-09-29 *
803 *********************************************************/
805 typedef struct sasl_canonuser {
806 /* optional features of plugin (set to 0) */
809 /* spare integer (set to 0) */
812 /* global state for plugin */
818 /* free global state for plugin */
819 void (*canon_user_free)(void *glob_context, const sasl_utils_t *utils);
821 /* canonicalize a username
822 * glob_context -- global context from this structure
823 * sparams -- server params, note user_realm&propctx elements
824 * user -- user to login as (may not be NUL terminated)
825 * len -- length of user name (0 = strlen(user))
826 * flags -- for SASL_CU_* flags
827 * out -- buffer to copy user name
828 * out_max -- max length of user name
829 * out_len -- set to length of user name
831 * note that the output buffers MAY be the same as the input buffers.
835 * SASL_BADPROT username contains invalid character
837 int (*canon_user_server)(void *glob_context,
838 sasl_server_params_t *sparams,
839 const char *user, unsigned len,
842 unsigned out_umax, unsigned *out_ulen);
844 int (*canon_user_client)(void *glob_context,
845 sasl_client_params_t *cparams,
846 const char *user, unsigned len,
849 unsigned out_max, unsigned *out_len);
851 /* for additions which don't require a version upgrade; set to 0 */
852 int (*spare_fptr1)();
853 int (*spare_fptr2)();
854 int (*spare_fptr3)();
855 } sasl_canonuser_plug_t;
857 #define SASL_CANONUSER_PLUG_VERSION 5
859 /* default name for canonuser plug-in entry point is "sasl_canonuser_init"
860 * similar to sasl_server_plug_init model, except only returns one
861 * sasl_canonuser_plug_t structure;
863 typedef int sasl_canonuser_init_t(const sasl_utils_t *utils,
866 sasl_canonuser_plug_t **plug,
867 const char *plugname);
869 /* add a canonuser plugin
871 LIBSASL_API int sasl_canonuser_add_plugin(const char *plugname,
872 sasl_canonuser_init_t *canonuserfunc);
874 /******************************************************
875 * auxiliary property plug-in -- added cjn 1999-09-29 *
876 ******************************************************/
878 typedef struct sasl_auxprop_plug {
879 /* optional features of plugin (none defined yet, set to 0) */
882 /* spare integer, must be set to 0 */
885 /* global state for plugin */
888 /* free global state for plugin (OPTIONAL) */
889 void (*auxprop_free)(void *glob_context, const sasl_utils_t *utils);
891 /* fill in fields of an auxiliary property context
892 * last element in array has id of SASL_AUX_END
893 * elements with non-0 len should be ignored.
895 void (*auxprop_lookup)(void *glob_context,
896 sasl_server_params_t *sparams,
898 const char *user, unsigned ulen);
900 /* name of the auxprop plugin */
903 /* store the fields/values of an auxiliary property context (OPTIONAL)
905 * if ctx is NULL, just check if storing properties is enabled
909 * SASL_FAIL on failure
911 int (*auxprop_store)(void *glob_context,
912 sasl_server_params_t *sparams,
914 const char *user, unsigned ulen);
915 } sasl_auxprop_plug_t;
917 /* auxprop lookup flags */
918 #define SASL_AUXPROP_OVERRIDE 0x01 /* if clear, ignore auxiliary properties
919 * with non-zero len field. If set,
920 * override value of those properties */
921 #define SASL_AUXPROP_AUTHZID 0x02 /* if clear, we are looking up the
922 * authid flags (prefixed with *), otherwise
923 * we are looking up the authzid flags
926 #define SASL_AUXPROP_PLUG_VERSION 4
928 /* default name for auxprop plug-in entry point is "sasl_auxprop_init"
929 * similar to sasl_server_plug_init model, except only returns one
930 * sasl_auxprop_plug_t structure;
932 typedef int sasl_auxprop_init_t(const sasl_utils_t *utils,
935 sasl_auxprop_plug_t **plug,
936 const char *plugname);
938 /* add an auxiliary property plug-in
940 LIBSASL_API int sasl_auxprop_add_plugin(const char *plugname,
941 sasl_auxprop_init_t *auxpropfunc);
943 typedef void auxprop_info_callback_t (sasl_auxprop_plug_t *m,
944 sasl_info_callback_stage_t stage,
947 /* Dump information about available auxprop plugins (separate functions are
948 used for canon and server authentication plugins) */
949 LIBSASL_API int auxprop_plugin_info (const char *mech_list,
950 auxprop_info_callback_t *info_cb,
957 #endif /* SASLPLUG_H */