include/saslplug.h

   1 /* saslplug.h --  API for SASL plug-ins
   2  */
   3
   4 #ifndef SASLPLUG_H
   5 #define SASLPLUG_H 1
   6
   7 #ifndef MD5GLOBAL_H
   8 #include "md5global.h"
   9 #endif
  10 #ifndef MD5_H
  11 #include "md5.h"
  12 #endif
  13 #ifndef HMAC_MD5_H
  14 #include "hmac-md5.h"
  15 #endif
  16 #ifndef PROP_H
  17 #include "prop.h"
  18 #endif
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /* callback to lookup a sasl_callback_t for a connection
  25  * input:
  26  *  conn        -- the connection to lookup a callback for
  27  *  callbacknum -- the number of the callback
  28  * output:
  29  *  pproc       -- pointer to the callback function (set to NULL on failure)
  30  *  pcontext    -- pointer to the callback context (set to NULL on failure)
  31  * returns:
  32  *  SASL_OK -- no error
  33  *  SASL_FAIL -- unable to find a callback of the requested type
  34  *  SASL_INTERACT -- caller must use interaction to get data
  35  */
  36 typedef int sasl_getcallback_t(sasl_conn_t *conn,
  37                                unsigned long callbackid,
  38                                int (**pproc)(),
  39                                void **pcontext);
  40
  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
  44  */
  45 #define SASL_UTILS_VERSION 4
  46
  47 /* utility function set for plug-ins
  48  */
  49 typedef struct sasl_utils {
  50     int version;
  51
  52     /* contexts */
  53     sasl_conn_t *conn;
  54     sasl_rand_t *rpool;
  55     void *getopt_context;
  56
  57     /* option function */
  58     sasl_getopt_t *getopt;
  59
  60     /* allocation functions: */
  61     sasl_malloc_t *malloc;
  62     sasl_calloc_t *calloc;
  63     sasl_realloc_t *realloc;
  64     sasl_free_t *free;
  65
  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;
  71
  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,
  78                      unsigned char [16]);
  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 *);
  85
  86     /* mechanism utility functions (same as above): */
  87     int (*mkchal)(sasl_conn_t *conn, char *buf, unsigned maxlen,
  88                   unsigned hostflag);
  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);
  92
  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.
  99      */
 100     int (*checkpass)(sasl_conn_t *conn,
 101                      const char *user, unsigned userlen,
 102                      const char *pass, unsigned passlen);
 103
 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);
 109
 110     /* erase a buffer */
 111     void (*erasebuffer)(char *buf, unsigned len);
 112
 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);
 116
 117     /* callback function */
 118     sasl_getcallback_t *getcallback;
 119
 120     /* format a message and then pass it to the SASL_CB_LOG callback
 121      *
 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.
 126      *
 127      * level is a SASL_LOG_* level (see sasl.h)
 128      */
 129     void (*log)(sasl_conn_t *conn, int level, const char *fmt, ...);
 130
 131     /* callback to sasl_seterror() */
 132     void (*seterror)(sasl_conn_t *conn, unsigned flags, const char *fmt, ...);
 133
 134     /* spare function pointer */
 135     int *(*spare_fptr)();
 136
 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);
 155
 156     /* for additions which don't require a version upgrade; set to 0 */
 157     int (*spare_fptr1)();
 158     int (*spare_fptr2)();
 159 } sasl_utils_t;
 160
 161 /*
 162  * output parameters from SASL API
 163  *
 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.
 166  *
 167  */
 168 typedef struct sasl_out_params {
 169     unsigned doneflag;          /* exchange complete */
 170
 171     const char *user;           /* canonicalized user name */
 172     const char *authid;         /* canonicalized authentication id */
 173
 174     unsigned ulen;              /* length of canonicalized user name */
 175     unsigned alen;              /* length of canonicalized authid */
 176
 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);
 190
 191     /* Pointer to delegated (client's) credentials, if supported by
 192        the SASL mechanism */
 193     void *client_creds;
 194
 195     /* for additions which don't require a version upgrade; set to 0 */
 196     void *gss_peer_name;
 197     void *gss_local_name;
 198     void *spare_ptr4;
 199     int (*spare_fptr1)();
 200     int (*spare_fptr2)();
 201     int spare_int1;
 202     int spare_int2;
 203     int spare_int3;
 204     int spare_int4;
 205
 206     /* set to 0 initially, this allows a plugin with extended parameters
 207      * to work with an older framework by updating version as parameters
 208      * are added.
 209      */
 210     int param_version;
 211 } sasl_out_params_t;
 212
 213
 214
 215 /* Used by both client and server side plugins */
 216 typedef enum  {
 217     SASL_INFO_LIST_START = 0,
 218     SASL_INFO_LIST_MECH,
 219     SASL_INFO_LIST_END
 220 } sasl_info_callback_stage_t;
 221
 222
 223
 224 /******************************
 225  * Client Mechanism Functions *
 226  ******************************/
 227
 228 /*
 229  * input parameters to client SASL plugin
 230  *
 231  * created / destroyed by the glue code
 232  *
 233  */
 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
 241                                  * called */
 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 */
 245
 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 */
 251
 252     /* application's security requirements & info */
 253     sasl_security_properties_t props;
 254     sasl_ssf_t external_ssf;    /* external SSF active */
 255
 256     /* for additions which don't require a version upgrade; set to 0 */
 257     void *gss_creds;
 258     void *chanbindingstype;
 259     void *chanbindingsdata;
 260     struct sasl_client_plug *plug;
 261
 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
 272      *
 273      *  responsible for setting user, ulen, authid, and alen in the oparams
 274      *  structure
 275      *
 276      *  default behavior is to strip leading and trailing whitespace, as
 277      *  well as allocating space for and copying the parameters.
 278      *
 279      * results:
 280      *  SASL_OK       -- success
 281      *  SASL_NOMEM    -- out of memory
 282      *  SASL_BADPARAM -- invalid conn
 283      *  SASL_BADPROT  -- invalid user/authid
 284      */
 285     int (*canon_user)(sasl_conn_t *conn,
 286                     const char *in, unsigned len,
 287                     unsigned flags,
 288                     sasl_out_params_t *oparams);
 289
 290     int (*spare_fptr1)();
 291
 292     int chanbindingslen;
 293     int spare_int2;
 294     int spare_int3;
 295
 296     /* flags field as passed to sasl_client_new */
 297     unsigned flags;
 298
 299     /* set to 0 initially, this allows a plugin with extended parameters
 300      * to work with an older framework by updating version as parameters
 301      * are added.
 302      */
 303     int param_version;
 304 } sasl_client_params_t;
 305
 306 /* features shared between client and server */
 307 /* These allow the glue code to handle client-first and server-last issues */
 308
 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
 312
 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 */
 317
 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 */
 321
 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.
 326  */
 327 #define SASL_FEAT_SERVER_FIRST 0x0010
 328
 329 /* This plugin allows proxying */
 330 #define SASL_FEAT_ALLOWS_PROXY 0x0020
 331
 332 /* Underlying mechanism uses GSS framing */
 333 #define SASL_FEAT_GSS_FRAMING       0x0040
 334 /* client plug-in features */
 335 #define SASL_FEAT_NEEDSERVERFQDN 0x0001
 336
 337 /* a C object for a client mechanism
 338  */
 339 typedef struct sasl_client_plug {
 340     /* mechanism name */
 341     const char *mech_name;
 342
 343     /* best mech additional security layer strength factor */
 344     sasl_ssf_t max_ssf;
 345
 346     /* best security flags, as defined in sasl_security_properties_t */
 347     unsigned security_flags;
 348
 349     /* features of plugin */
 350     unsigned features;
 351
 352     /* required prompt ids, NULL = user/pass only */
 353     const unsigned long *required_prompts;
 354
 355     /* global state for mechanism */
 356     void *glob_context;
 357
 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
 362      * returns:
 363      *  SASL_OK        -- success
 364      *  SASL_NOMEM     -- not enough memory
 365      *  SASL_WRONGMECH -- mech doesn't support security params
 366      */
 367     int (*mech_new)(void *glob_context,
 368                     sasl_client_params_t *cparams,
 369                     void **conn_context);
 370
 371     /* perform one step of exchange.  NULL is passed for serverin on
 372      * first step.
 373      * returns:
 374      *  SASL_OK        -- success
 375      *  SASL_INTERACT  -- user interaction needed to fill in prompts
 376      *  SASL_BADPROT   -- server protocol incorrect/cancelled
 377      *  SASL_BADSERV   -- server failed mutual auth
 378      */
 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);
 387
 388     /* dispose of connection context from mech_new
 389      */
 390     void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
 391
 392     /* free all global space used by mechanism
 393      *  mech_dispose must be called on all mechanisms first
 394      */
 395     void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
 396
 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
 400      */
 401     int (*idle)(void *glob_context,
 402                 void *conn_context,
 403                 sasl_client_params_t *cparams);
 404
 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;
 409
 410 #define SASL_CLIENT_PLUG_VERSION         4
 411
 412 /* plug-in entry point:
 413  *  utils       -- utility callback functions
 414  *  max_version -- highest client plug version supported
 415  * returns:
 416  *  out_version -- client plug version of result
 417  *  pluglist    -- list of mechanism plug-ins
 418  *  plugcount   -- number of mechanism plug-ins
 419  * results:
 420  *  SASL_OK       -- success
 421  *  SASL_NOMEM    -- failure
 422  *  SASL_BADVERS  -- max_version too small
 423  *  SASL_BADPARAM -- bad config string
 424  *  ...
 425  */
 426 typedef int sasl_client_plug_init_t(const sasl_utils_t *utils,
 427                                     int max_version,
 428                                     int *out_version,
 429                                     sasl_client_plug_t **pluglist,
 430                                     int *plugcount);
 431
 432
 433 /* add a client plug-in
 434  */
 435 LIBSASL_API int sasl_client_add_plugin(const char *plugname,
 436                                        sasl_client_plug_init_t *cplugfunc);
 437
 438 typedef struct client_sasl_mechanism
 439 {
 440     int version;
 441
 442     char *plugname;
 443     const sasl_client_plug_t *plug;
 444 } client_sasl_mechanism_t;
 445
 446 typedef void sasl_client_info_callback_t (client_sasl_mechanism_t *m,
 447                                           sasl_info_callback_stage_t stage,
 448                                           void *rock);
 449
 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,
 453         void *info_cb_rock);
 454
 455
 456 /********************
 457  * Server Functions *
 458  ********************/
 459
 460 /* log message formatting routine */
 461 typedef void sasl_logmsg_p(sasl_conn_t *conn, const char *fmt, ...);
 462
 463 struct sasl_server_plug;
 464
 465 /*
 466  * input parameters to server SASL plugin
 467  *
 468  * created / destroyed by the glue code
 469  *
 470  */
 471 typedef struct sasl_server_params {
 472     const char *service;        /* NULL = default service for user_exists
 473                                    and setpass */
 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 */
 480
 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 */
 487
 488     /* This indicates the level of logging desired.  See SASL_LOG_*
 489      * in sasl.h
 490      *
 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
 495      */
 496     int log_level;
 497
 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
 501                                  * called */
 502     const sasl_callback_t *callbacks;   /* Callbacks from application */
 503
 504     /* application's security requirements */
 505     sasl_security_properties_t props;
 506     sasl_ssf_t external_ssf;    /* external SSF active */
 507
 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)
 511      *
 512      *  If passlen is 0, it defaults to strlen(pass).
 513      *  returns 0 if no entry added, 1 if entry added
 514      */
 515     int (*transition)(sasl_conn_t *conn, const char *pass, unsigned passlen);
 516
 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
 527      *
 528      *  responsible for setting user, ulen, authid, and alen in the oparams
 529      *  structure
 530      *
 531      *  default behavior is to strip leading and trailing whitespace, as
 532      *  well as allocating space for and copying the parameters.
 533      *
 534      * results:
 535      *  SASL_OK       -- success
 536      *  SASL_NOMEM    -- out of memory
 537      *  SASL_BADPARAM -- invalid conn
 538      *  SASL_BADPROT  -- invalid user/authid
 539      */
 540     int (*canon_user)(sasl_conn_t *conn,
 541                       const char *user, unsigned ulen,
 542                       unsigned flags,
 543                       sasl_out_params_t *oparams);
 544
 545     /* auxiliary property context (see definitions in prop.h)
 546      *  added cjn 2000-01-30
 547      *
 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.
 553      */
 554     struct propctx *propctx;
 555
 556     /* for additions which don't require a version upgrade; set to 0 */
 557     void *gss_creds;
 558     void *chanbindingstype;
 559     void *chanbindingsdata;
 560     struct sasl_server_plug *plug;
 561     int (*spare_fptr1)();
 562     int (*spare_fptr2)();
 563     int chanbindingslen;
 564     int spare_int2;
 565     int spare_int3;
 566
 567     /* flags field as passed to sasl_server_new */
 568     unsigned flags;
 569
 570     /* set to 0 initially, this allows a plugin with extended parameters
 571      * to work with an older framework by updating version as parameters
 572      * are added.
 573      */
 574     int param_version;
 575 } sasl_server_params_t;
 576
 577 /* logging levels (more levels may be added later, if necessary):
 578  */
 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
 587                                  * passwords */
 588
 589 /* additional flags for setpass() function below:
 590  */
 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 */
 594
 595 /* features for server plug-in
 596  */
 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 */
 600
 601 /* a C object for a server mechanism
 602  */
 603 typedef struct sasl_server_plug {
 604     /* mechanism name */
 605     const char *mech_name;
 606
 607     /* best mech additional security layer strength factor */
 608     sasl_ssf_t max_ssf;
 609
 610     /* best security flags, as defined in sasl_security_properties_t */
 611     unsigned security_flags;
 612
 613     /* features of plugin */
 614     unsigned features;
 615
 616     /* global state for mechanism */
 617     void *glob_context;
 618
 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
 624      * out:
 625      *  conn_context  -- connection context
 626      *  errinfo       -- error information
 627      *
 628      * returns:
 629      *  SASL_OK       -- successfully created mech instance
 630      *  SASL_*        -- any other server error code
 631      */
 632     int (*mech_new)(void *glob_context,
 633                     sasl_server_params_t *sparams,
 634                     const char *challenge,
 635                     unsigned challen,
 636                     void **conn_context);
 637
 638     /* perform one step in exchange
 639      *
 640      * returns:
 641      *  SASL_OK       -- success, all done
 642      *  SASL_CONTINUE -- success, one more round trip
 643      *  SASL_*        -- any other server error code
 644      */
 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);
 652
 653     /* dispose of a connection state
 654      */
 655     void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
 656
 657     /* free global state for mechanism
 658      *  mech_dispose must be called on all mechanisms first
 659      */
 660     void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
 661
 662     /* set a password (optional)
 663      *  glob_context  -- global context
 664      *  sparams       -- service, middleware utilities, etc. props ignored
 665      *  user          -- user name
 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
 670      *  flags         -- see above
 671      *
 672      * returns:
 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
 678      *  etc.
 679      */
 680     int (*setpass)(void *glob_context,
 681                    sasl_server_params_t *sparams,
 682                    const char *user,
 683                    const char *pass, unsigned passlen,
 684                    const char *oldpass, unsigned oldpasslen,
 685                    unsigned flags);
 686
 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)
 692      * output:
 693      *  mechlist      -- an array of C string pointers, filled in with
 694      *                   mechanism names available to the user
 695      *
 696      * returns:
 697      *  SASL_OK       -- success
 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
 704      */
 705     int (*user_query)(void *glob_context,
 706                       sasl_server_params_t *sparams,
 707                       const char *user,
 708                       int maxmech,
 709                       const char **mechlist);
 710
 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
 714      */
 715     int (*idle)(void *glob_context,
 716                 void *conn_context,
 717                 sasl_server_params_t *sparams);
 718
 719     /* check if mechanism is available
 720      *  optional--if NULL, mechanism is available based on ENABLE= in config
 721      *
 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.
 727      *
 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
 734      *  or SASL_NOMECH.
 735      *
 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
 740      */
 741     int (*mech_avail)(void *glob_context,
 742                       sasl_server_params_t *sparams,
 743                       void **conn_context);
 744
 745     /* for additions which don't require a version upgrade; set to 0 */
 746     int (*spare_fptr2)();
 747 } sasl_server_plug_t;
 748
 749 #define SASL_SERVER_PLUG_VERSION 4
 750
 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
 755  * returns:
 756  *  out_version   -- server plug-in version of result
 757  *  pluglist      -- list of mechanism plug-ins
 758  *  plugcount     -- number of mechanism plug-ins
 759  * results:
 760  *  SASL_OK       -- success
 761  *  SASL_NOMEM    -- failure
 762  *  SASL_BADVERS  -- max_version too small
 763  *  SASL_BADPARAM -- bad config string
 764  *  ...
 765  */
 766 typedef int sasl_server_plug_init_t(const sasl_utils_t *utils,
 767                                     int max_version,
 768                                     int *out_version,
 769                                     sasl_server_plug_t **pluglist,
 770                                     int *plugcount);
 771
 772 /*
 773  * add a server plug-in
 774  */
 775 LIBSASL_API int sasl_server_add_plugin(const char *plugname,
 776                                        sasl_server_plug_init_t *splugfunc);
 777
 778
 779 typedef struct server_sasl_mechanism
 780 {
 781     int version;
 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;
 788
 789 typedef void sasl_server_info_callback_t (server_sasl_mechanism_t *m,
 790                                           sasl_info_callback_stage_t stage,
 791                                           void *rock);
 792
 793
 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,
 798         void *info_cb_rock);
 799
 800
 801 /*********************************************************
 802  * user canonicalization plug-in -- added cjn 1999-09-29 *
 803  *********************************************************/
 804
 805 typedef struct sasl_canonuser {
 806     /* optional features of plugin (set to 0) */
 807     int features;
 808
 809     /* spare integer (set to 0) */
 810     int spare_int1;
 811
 812     /* global state for plugin */
 813     void *glob_context;
 814
 815     /* name of plugin */
 816     char *name;
 817
 818     /* free global state for plugin */
 819     void (*canon_user_free)(void *glob_context, const sasl_utils_t *utils);
 820
 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
 830      *
 831      *  note that the output buffers MAY be the same as the input buffers.
 832      *
 833      * returns
 834      *  SASL_OK         on success
 835      *  SASL_BADPROT    username contains invalid character
 836      */
 837     int (*canon_user_server)(void *glob_context,
 838                              sasl_server_params_t *sparams,
 839                              const char *user, unsigned len,
 840                              unsigned flags,
 841                              char *out,
 842                              unsigned out_umax, unsigned *out_ulen);
 843
 844     int (*canon_user_client)(void *glob_context,
 845                              sasl_client_params_t *cparams,
 846                              const char *user, unsigned len,
 847                              unsigned flags,
 848                              char *out,
 849                              unsigned out_max, unsigned *out_len);
 850
 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;
 856
 857 #define SASL_CANONUSER_PLUG_VERSION 5
 858
 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;
 862  */
 863 typedef int sasl_canonuser_init_t(const sasl_utils_t *utils,
 864                                   int max_version,
 865                                   int *out_version,
 866                                   sasl_canonuser_plug_t **plug,
 867                                   const char *plugname);
 868
 869 /* add a canonuser plugin
 870  */
 871 LIBSASL_API int sasl_canonuser_add_plugin(const char *plugname,
 872                                   sasl_canonuser_init_t *canonuserfunc);
 873
 874 /******************************************************
 875  * auxiliary property plug-in -- added cjn 1999-09-29 *
 876  ******************************************************/
 877
 878 typedef struct sasl_auxprop_plug {
 879     /* optional features of plugin (none defined yet, set to 0) */
 880     int features;
 881
 882     /* spare integer, must be set to 0 */
 883     int spare_int1;
 884
 885     /* global state for plugin */
 886     void *glob_context;
 887
 888     /* free global state for plugin (OPTIONAL) */
 889     void (*auxprop_free)(void *glob_context, const sasl_utils_t *utils);
 890
 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.
 894      */
 895     void (*auxprop_lookup)(void *glob_context,
 896                            sasl_server_params_t *sparams,
 897                            unsigned flags,
 898                            const char *user, unsigned ulen);
 899
 900     /* name of the auxprop plugin */
 901     char *name;
 902
 903     /* store the fields/values of an auxiliary property context (OPTIONAL)
 904      *
 905      * if ctx is NULL, just check if storing properties is enabled
 906      *
 907      * returns
 908      *  SASL_OK         on success
 909      *  SASL_FAIL       on failure
 910      */
 911     int (*auxprop_store)(void *glob_context,
 912                          sasl_server_params_t *sparams,
 913                          struct propctx *ctx,
 914                          const char *user, unsigned ulen);
 915 } sasl_auxprop_plug_t;
 916
 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
 924                                     * (no prefix) */
 925
 926 #define SASL_AUXPROP_PLUG_VERSION 4
 927
 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;
 931  */
 932 typedef int sasl_auxprop_init_t(const sasl_utils_t *utils,
 933                                 int max_version,
 934                                 int *out_version,
 935                                 sasl_auxprop_plug_t **plug,
 936                                 const char *plugname);
 937
 938 /* add an auxiliary property plug-in
 939  */
 940 LIBSASL_API int sasl_auxprop_add_plugin(const char *plugname,
 941                                         sasl_auxprop_init_t *auxpropfunc);
 942
 943 typedef void auxprop_info_callback_t (sasl_auxprop_plug_t *m,
 944                                       sasl_info_callback_stage_t stage,
 945                                       void *rock);
 946
 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,
 951         void *info_cb_rock);
 952
 953 #ifdef __cplusplus
 954 }
 955 #endif
 956
 957 #endif /* SASLPLUG_H */