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 chanbindingflag;
 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 *chanbindingtype;
 259     void *chanbindingdata;
 260     void *spare_ptr4;
 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 #define SASL_CB_FLAG_NONE   0x00    /* client did not support CB */
 293 #define SASL_CB_FLAG_USED   0x01    /* client supports CB, thinks server does not */
 294 #define SASL_CB_FLAG_WANT   0x02    /* client supports and used CB */
 295 #define SASL_CB_FLAG_CRIT   0x10    /* client requires CB */
 296     int chanbindingflags;
 297 #define SASL_CB_PRESENT(params) ((params)->chanbindingtype != NULL && (params)->chanbindinglen)
 298     int chanbindinglen;
 299     int spare_int3;
 300
 301     /* flags field as passed to sasl_client_new */
 302     unsigned flags;
 303
 304     /* set to 0 initially, this allows a plugin with extended parameters
 305      * to work with an older framework by updating version as parameters
 306      * are added.
 307      */
 308     int param_version;
 309 } sasl_client_params_t;
 310
 311 /* features shared between client and server */
 312 /* These allow the glue code to handle client-first and server-last issues */
 313
 314 /* This indicates that the mechanism prefers to do client-send-first
 315  * if the protocol allows it. */
 316 #define SASL_FEAT_WANT_CLIENT_FIRST 0x0002
 317
 318 /* This feature is deprecated, instead, plugins should set *serverout to
 319  * non-NULL and return SASL_OK intelligently to allow flexible use of
 320  * server-last semantics */
 321 /* #define SASL_FEAT_WANT_SERVER_LAST 0x0004 */
 322
 323 /* This feature is deprecated, instead plugins should correctly set
 324  * SASL_FEAT_SERVER_FIRST as needed */
 325 /* #define SASL_FEAT_INTERNAL_CLIENT_FIRST 0x0008 */
 326
 327 /* This indicates that the plugin is server-first only.
 328  * Not defining either of SASL_FEAT_SERVER_FIRST or
 329  * SASL_FEAT_WANT_CLIENT_FIRST indicates that the mechanism will take care
 330  * of the client-first situation internally.
 331  */
 332 #define SASL_FEAT_SERVER_FIRST 0x0010
 333
 334 /* This plugin allows proxying */
 335 #define SASL_FEAT_ALLOWS_PROXY 0x0020
 336
 337 /* Underlying mechanism uses GSS framing */
 338 #define SASL_FEAT_GSS_FRAMING       0x0040
 339
 340 /* Underlying mechanism supports channel binding */
 341 #define SASL_FEAT_CHANNEL_BINDING  0x0080
 342
 343 /* client plug-in features */
 344 #define SASL_FEAT_NEEDSERVERFQDN 0x0001
 345
 346 /* a C object for a client mechanism
 347  */
 348 typedef struct sasl_client_plug {
 349     /* mechanism name */
 350     const char *mech_name;
 351
 352     /* best mech additional security layer strength factor */
 353     sasl_ssf_t max_ssf;
 354
 355     /* best security flags, as defined in sasl_security_properties_t */
 356     unsigned security_flags;
 357
 358     /* features of plugin */
 359     unsigned features;
 360
 361     /* required prompt ids, NULL = user/pass only */
 362     const unsigned long *required_prompts;
 363
 364     /* global state for mechanism */
 365     void *glob_context;
 366
 367     /* create context for mechanism, using params supplied
 368      *  glob_context   -- from above
 369      *  params         -- params from sasl_client_new
 370      *  conn_context   -- context for one connection
 371      * returns:
 372      *  SASL_OK        -- success
 373      *  SASL_NOMEM     -- not enough memory
 374      *  SASL_WRONGMECH -- mech doesn't support security params
 375      */
 376     int (*mech_new)(void *glob_context,
 377                     sasl_client_params_t *cparams,
 378                     void **conn_context);
 379
 380     /* perform one step of exchange.  NULL is passed for serverin on
 381      * first step.
 382      * returns:
 383      *  SASL_OK        -- success
 384      *  SASL_INTERACT  -- user interaction needed to fill in prompts
 385      *  SASL_BADPROT   -- server protocol incorrect/cancelled
 386      *  SASL_BADSERV   -- server failed mutual auth
 387      */
 388     int (*mech_step)(void *conn_context,
 389                      sasl_client_params_t *cparams,
 390                      const char *serverin,
 391                      unsigned serverinlen,
 392                      sasl_interact_t **prompt_need,
 393                      const char **clientout,
 394                      unsigned *clientoutlen,
 395                      sasl_out_params_t *oparams);
 396
 397     /* dispose of connection context from mech_new
 398      */
 399     void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
 400
 401     /* free all global space used by mechanism
 402      *  mech_dispose must be called on all mechanisms first
 403      */
 404     void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
 405
 406     /* perform precalculations during a network round-trip
 407      *  or idle period.  conn_context may be NULL
 408      *  returns 1 if action taken, 0 if no action taken
 409      */
 410     int (*idle)(void *glob_context,
 411                 void *conn_context,
 412                 sasl_client_params_t *cparams);
 413
 414     /* for additions which don't require a version upgrade; set to 0 */
 415     int (*spare_fptr1)();
 416     int (*spare_fptr2)();
 417 } sasl_client_plug_t;
 418
 419 #define SASL_CLIENT_PLUG_VERSION         4
 420
 421 /* plug-in entry point:
 422  *  utils       -- utility callback functions
 423  *  max_version -- highest client plug version supported
 424  * returns:
 425  *  out_version -- client plug version of result
 426  *  pluglist    -- list of mechanism plug-ins
 427  *  plugcount   -- number of mechanism plug-ins
 428  * results:
 429  *  SASL_OK       -- success
 430  *  SASL_NOMEM    -- failure
 431  *  SASL_BADVERS  -- max_version too small
 432  *  SASL_BADPARAM -- bad config string
 433  *  ...
 434  */
 435 typedef int sasl_client_plug_init_t(const sasl_utils_t *utils,
 436                                     int max_version,
 437                                     int *out_version,
 438                                     sasl_client_plug_t **pluglist,
 439                                     int *plugcount);
 440
 441
 442 /* add a client plug-in
 443  */
 444 LIBSASL_API int sasl_client_add_plugin(const char *plugname,
 445                                        sasl_client_plug_init_t *cplugfunc);
 446
 447 typedef struct client_sasl_mechanism
 448 {
 449     int version;
 450
 451     char *plugname;
 452     const sasl_client_plug_t *plug;
 453 } client_sasl_mechanism_t;
 454
 455 typedef void sasl_client_info_callback_t (client_sasl_mechanism_t *m,
 456                                           sasl_info_callback_stage_t stage,
 457                                           void *rock);
 458
 459 /* Dump information about available client plugins */
 460 LIBSASL_API int sasl_client_plugin_info (const char *mech_list,
 461         sasl_client_info_callback_t *info_cb,
 462         void *info_cb_rock);
 463
 464
 465 /********************
 466  * Server Functions *
 467  ********************/
 468
 469 /* log message formatting routine */
 470 typedef void sasl_logmsg_p(sasl_conn_t *conn, const char *fmt, ...);
 471
 472 /*
 473  * input parameters to server SASL plugin
 474  *
 475  * created / destroyed by the glue code
 476  *
 477  */
 478 typedef struct sasl_server_params {
 479     const char *service;        /* NULL = default service for user_exists
 480                                    and setpass */
 481     const char *appname;        /* name of calling application */
 482     const char *serverFQDN;     /* server default fully qualified domain name
 483                                  * (e.g., gethostname) */
 484     const char *user_realm;     /* realm for user (NULL = client supplied) */
 485     const char *iplocalport;    /* server IP domain literal & port */
 486     const char *ipremoteport;   /* client IP domain literal & port */
 487
 488     unsigned servicelen;        /* length of service */
 489     unsigned applen;            /* length of appname */
 490     unsigned slen;              /* length of serverFQDN */
 491     unsigned urlen;             /* length of user_realm */
 492     unsigned iploclen;          /* length of iplocalport */
 493     unsigned ipremlen;          /* length of ipremoteport */
 494
 495     /* This indicates the level of logging desired.  See SASL_LOG_*
 496      * in sasl.h
 497      *
 498      * Plug-ins can ignore this and just pass their desired level to
 499      * the log callback.  This is primarily used to eliminate logging which
 500      * might be a performance problem (e.g., full protocol trace) and
 501      * to select between SASL_LOG_TRACE and SASL_LOG_PASS alternatives
 502      */
 503     int log_level;
 504
 505     const sasl_utils_t *utils;  /* SASL API utility routines --
 506                                  * for a particular sasl_conn_t,
 507                                  * MUST remain valid until mech_free is
 508                                  * called */
 509     const sasl_callback_t *callbacks;   /* Callbacks from application */
 510
 511     /* application's security requirements */
 512     sasl_security_properties_t props;
 513     sasl_ssf_t external_ssf;    /* external SSF active */
 514
 515     /* Pointer to the function which takes the plaintext passphrase and
 516      *  transitions a user to non-plaintext mechanisms via setpass calls.
 517      *  (NULL = auto transition not enabled/supported)
 518      *
 519      *  If passlen is 0, it defaults to strlen(pass).
 520      *  returns 0 if no entry added, 1 if entry added
 521      */
 522     int (*transition)(sasl_conn_t *conn, const char *pass, unsigned passlen);
 523
 524     /* Canonicalize a user name from on-wire to internal format
 525      *  added cjn 1999-09-21
 526      *  Must be called once user name acquired if canon_user is non-NULL.
 527      *  conn        connection context
 528      *  user        user name from wire protocol (need not be NUL terminated)
 529      *  ulen        length of user name from wire protocol (0 = strlen(user))
 530      *  flags       for SASL_CU_* flags
 531      *  oparams     the user, authid, ulen, alen, fields are
 532      *              set appropriately after canonicalization/copying and
 533      *              authorization of arguments
 534      *
 535      *  responsible for setting user, ulen, authid, and alen in the oparams
 536      *  structure
 537      *
 538      *  default behavior is to strip leading and trailing whitespace, as
 539      *  well as allocating space for and copying the parameters.
 540      *
 541      * results:
 542      *  SASL_OK       -- success
 543      *  SASL_NOMEM    -- out of memory
 544      *  SASL_BADPARAM -- invalid conn
 545      *  SASL_BADPROT  -- invalid user/authid
 546      */
 547     int (*canon_user)(sasl_conn_t *conn,
 548                       const char *user, unsigned ulen,
 549                       unsigned flags,
 550                       sasl_out_params_t *oparams);
 551
 552     /* auxiliary property context (see definitions in prop.h)
 553      *  added cjn 2000-01-30
 554      *
 555      * NOTE: these properties are the ones associated with the
 556      * canonicalized "user" (user to login as / authorization id), not
 557      * the "authid" (user whose credentials are used / authentication id)
 558      * Prefix the property name with a "*" if a property associated with
 559      * the "authid" is interesting.
 560      */
 561     struct propctx *propctx;
 562
 563     /* for additions which don't require a version upgrade; set to 0 */
 564     void *gss_creds;
 565     void *chanbindingtype;
 566     void *chanbindingdata;
 567     void *spare_ptr4;
 568     int (*spare_fptr1)();
 569     int (*spare_fptr2)();
 570     int chanbindinglen;
 571     int chanbindingcrit;
 572     int spare_int3;
 573
 574     /* flags field as passed to sasl_server_new */
 575     unsigned flags;
 576
 577     /* set to 0 initially, this allows a plugin with extended parameters
 578      * to work with an older framework by updating version as parameters
 579      * are added.
 580      */
 581     int param_version;
 582 } sasl_server_params_t;
 583
 584 /* logging levels (more levels may be added later, if necessary):
 585  */
 586 #define SASL_LOG_NONE  0        /* don't log anything */
 587 #define SASL_LOG_ERR   1        /* log unusual errors (default) */
 588 #define SASL_LOG_FAIL  2        /* log all authentication failures */
 589 #define SASL_LOG_WARN  3        /* log non-fatal warnings */
 590 #define SASL_LOG_NOTE  4        /* more verbose than LOG_WARN */
 591 #define SASL_LOG_DEBUG 5        /* more verbose than LOG_NOTE */
 592 #define SASL_LOG_TRACE 6        /* traces of internal protocols */
 593 #define SASL_LOG_PASS  7        /* traces of internal protocols, including
 594                                  * passwords */
 595
 596 /* additional flags for setpass() function below:
 597  */
 598 /*      SASL_SET_CREATE                     create user if pass non-NULL */
 599 /*      SASL_SET_DISABLE                    disable user */
 600 #define SASL_SET_REMOVE  SASL_SET_CREATE /* remove user if pass is NULL */
 601
 602 /* features for server plug-in
 603  */
 604 #define SASL_FEAT_SERVICE    0x0200 /* service-specific passwords supported */
 605 #define SASL_FEAT_GETSECRET  0x0400 /* sasl_server_{get,put}secret_t callbacks
 606                                      * required by plug-in */
 607
 608 /* a C object for a server mechanism
 609  */
 610 typedef struct sasl_server_plug {
 611     /* mechanism name */
 612     const char *mech_name;
 613
 614     /* best mech additional security layer strength factor */
 615     sasl_ssf_t max_ssf;
 616
 617     /* best security flags, as defined in sasl_security_properties_t */
 618     unsigned security_flags;
 619
 620     /* features of plugin */
 621     unsigned features;
 622
 623     /* global state for mechanism */
 624     void *glob_context;
 625
 626     /* create a new mechanism handler
 627      *  glob_context  -- global context
 628      *  sparams       -- server config params
 629      *  challenge     -- server challenge from previous instance or NULL
 630      *  challen       -- length of challenge from previous instance or 0
 631      * out:
 632      *  conn_context  -- connection context
 633      *  errinfo       -- error information
 634      *
 635      * returns:
 636      *  SASL_OK       -- successfully created mech instance
 637      *  SASL_*        -- any other server error code
 638      */
 639     int (*mech_new)(void *glob_context,
 640                     sasl_server_params_t *sparams,
 641                     const char *challenge,
 642                     unsigned challen,
 643                     void **conn_context);
 644
 645     /* perform one step in exchange
 646      *
 647      * returns:
 648      *  SASL_OK       -- success, all done
 649      *  SASL_CONTINUE -- success, one more round trip
 650      *  SASL_*        -- any other server error code
 651      */
 652     int (*mech_step)(void *conn_context,
 653                      sasl_server_params_t *sparams,
 654                      const char *clientin,
 655                      unsigned clientinlen,
 656                      const char **serverout,
 657                      unsigned *serveroutlen,
 658                      sasl_out_params_t *oparams);
 659
 660     /* dispose of a connection state
 661      */
 662     void (*mech_dispose)(void *conn_context, const sasl_utils_t *utils);
 663
 664     /* free global state for mechanism
 665      *  mech_dispose must be called on all mechanisms first
 666      */
 667     void (*mech_free)(void *glob_context, const sasl_utils_t *utils);
 668
 669     /* set a password (optional)
 670      *  glob_context  -- global context
 671      *  sparams       -- service, middleware utilities, etc. props ignored
 672      *  user          -- user name
 673      *  pass          -- password/passphrase (NULL = disable/remove/delete)
 674      *  passlen       -- length of password/passphrase
 675      *  oldpass       -- old password/passphrase (NULL = transition)
 676      *  oldpasslen    -- length of password/passphrase
 677      *  flags         -- see above
 678      *
 679      * returns:
 680      *  SASL_NOCHANGE -- no change was needed
 681      *  SASL_NOUSER   -- no entry for user
 682      *  SASL_NOVERIFY -- no mechanism compatible entry for user
 683      *  SASL_PWLOCK   -- password locked
 684      *  SASL_DIABLED  -- account disabled
 685      *  etc.
 686      */
 687     int (*setpass)(void *glob_context,
 688                    sasl_server_params_t *sparams,
 689                    const char *user,
 690                    const char *pass, unsigned passlen,
 691                    const char *oldpass, unsigned oldpasslen,
 692                    unsigned flags);
 693
 694     /* query which mechanisms are available for user
 695      *  glob_context  -- context
 696      *  sparams       -- service, middleware utilities, etc. props ignored
 697      *  user          -- NUL terminated user name
 698      *  maxmech       -- max number of strings in mechlist (0 = no output)
 699      * output:
 700      *  mechlist      -- an array of C string pointers, filled in with
 701      *                   mechanism names available to the user
 702      *
 703      * returns:
 704      *  SASL_OK       -- success
 705      *  SASL_NOMEM    -- not enough memory
 706      *  SASL_FAIL     -- lower level failure
 707      *  SASL_DISABLED -- account disabled
 708      *  SASL_NOUSER   -- user not found
 709      *  SASL_BUFOVER  -- maxmech is too small
 710      *  SASL_NOVERIFY -- user found, but no mechanisms available
 711      */
 712     int (*user_query)(void *glob_context,
 713                       sasl_server_params_t *sparams,
 714                       const char *user,
 715                       int maxmech,
 716                       const char **mechlist);
 717
 718     /* perform precalculations during a network round-trip
 719      *  or idle period.  conn_context may be NULL (optional)
 720      *  returns 1 if action taken, 0 if no action taken
 721      */
 722     int (*idle)(void *glob_context,
 723                 void *conn_context,
 724                 sasl_server_params_t *sparams);
 725
 726     /* check if mechanism is available
 727      *  optional--if NULL, mechanism is available based on ENABLE= in config
 728      *
 729      *  If this routine sets conn_context to a non-NULL value, then the call
 730      *  to mech_new will be skipped.  This should not be done unless
 731      *  there's a significant performance benefit, since it can cause
 732      *  additional memory allocation in SASL core code to keep track of
 733      *  contexts potentially for multiple mechanisms.
 734      *
 735      *  This is called by the first call to sasl_listmech() for a
 736      *  given connection context, thus for a given protocol it may
 737      *  never be called.  Note that if mech_avail returns SASL_NOMECH,
 738      *  then that mechanism is considered disabled for the remainder
 739      *  of the session.  If mech_avail returns SASL_NOTDONE, then a
 740      *  future call to mech_avail may still return either SASL_OK
 741      *  or SASL_NOMECH.
 742      *
 743      *  returns SASL_OK on success,
 744      *          SASL_NOTDONE if mech is not available now, but may be later
 745      *                       (e.g. EXTERNAL w/o auth_id)
 746      *          SASL_NOMECH if mech disabled
 747      */
 748     int (*mech_avail)(void *glob_context,
 749                       sasl_server_params_t *sparams,
 750                       void **conn_context);
 751
 752     /* for additions which don't require a version upgrade; set to 0 */
 753     int (*spare_fptr2)();
 754 } sasl_server_plug_t;
 755
 756 #define SASL_SERVER_PLUG_VERSION 4
 757
 758 /* plug-in entry point:
 759  *  utils         -- utility callback functions
 760  *  plugname      -- name of plug-in (may be NULL)
 761  *  max_version   -- highest server plug version supported
 762  * returns:
 763  *  out_version   -- server plug-in version of result
 764  *  pluglist      -- list of mechanism plug-ins
 765  *  plugcount     -- number of mechanism plug-ins
 766  * results:
 767  *  SASL_OK       -- success
 768  *  SASL_NOMEM    -- failure
 769  *  SASL_BADVERS  -- max_version too small
 770  *  SASL_BADPARAM -- bad config string
 771  *  ...
 772  */
 773 typedef int sasl_server_plug_init_t(const sasl_utils_t *utils,
 774                                     int max_version,
 775                                     int *out_version,
 776                                     sasl_server_plug_t **pluglist,
 777                                     int *plugcount);
 778
 779 /*
 780  * add a server plug-in
 781  */
 782 LIBSASL_API int sasl_server_add_plugin(const char *plugname,
 783                                        sasl_server_plug_init_t *splugfunc);
 784
 785
 786 typedef struct server_sasl_mechanism
 787 {
 788     int version;
 789     int condition; /* set to SASL_NOUSER if no available users;
 790                       set to SASL_CONTINUE if delayed plugin loading */
 791     char *plugname; /* for AUTHSOURCE tracking */
 792     const sasl_server_plug_t *plug;
 793     char *f;       /* where should i load the mechanism from? */
 794 } server_sasl_mechanism_t;
 795
 796 typedef void sasl_server_info_callback_t (server_sasl_mechanism_t *m,
 797                                           sasl_info_callback_stage_t stage,
 798                                           void *rock);
 799
 800
 801 /* Dump information about available server plugins (separate functions are
 802    used for canon and auxprop plugins) */
 803 LIBSASL_API int sasl_server_plugin_info (const char *mech_list,
 804         sasl_server_info_callback_t *info_cb,
 805         void *info_cb_rock);
 806
 807
 808 /*********************************************************
 809  * user canonicalization plug-in -- added cjn 1999-09-29 *
 810  *********************************************************/
 811
 812 typedef struct sasl_canonuser {
 813     /* optional features of plugin (set to 0) */
 814     int features;
 815
 816     /* spare integer (set to 0) */
 817     int spare_int1;
 818
 819     /* global state for plugin */
 820     void *glob_context;
 821
 822     /* name of plugin */
 823     char *name;
 824
 825     /* free global state for plugin */
 826     void (*canon_user_free)(void *glob_context, const sasl_utils_t *utils);
 827
 828     /* canonicalize a username
 829      *  glob_context     -- global context from this structure
 830      *  sparams          -- server params, note user_realm&propctx elements
 831      *  user             -- user to login as (may not be NUL terminated)
 832      *  len              -- length of user name (0 = strlen(user))
 833      *  flags            -- for SASL_CU_* flags
 834      *  out              -- buffer to copy user name
 835      *  out_max          -- max length of user name
 836      *  out_len          -- set to length of user name
 837      *
 838      *  note that the output buffers MAY be the same as the input buffers.
 839      *
 840      * returns
 841      *  SASL_OK         on success
 842      *  SASL_BADPROT    username contains invalid character
 843      */
 844     int (*canon_user_server)(void *glob_context,
 845                              sasl_server_params_t *sparams,
 846                              const char *user, unsigned len,
 847                              unsigned flags,
 848                              char *out,
 849                              unsigned out_umax, unsigned *out_ulen);
 850
 851     int (*canon_user_client)(void *glob_context,
 852                              sasl_client_params_t *cparams,
 853                              const char *user, unsigned len,
 854                              unsigned flags,
 855                              char *out,
 856                              unsigned out_max, unsigned *out_len);
 857
 858     /* for additions which don't require a version upgrade; set to 0 */
 859     int (*spare_fptr1)();
 860     int (*spare_fptr2)();
 861     int (*spare_fptr3)();
 862 } sasl_canonuser_plug_t;
 863
 864 #define SASL_CANONUSER_PLUG_VERSION 5
 865
 866 /* default name for canonuser plug-in entry point is "sasl_canonuser_init"
 867  *  similar to sasl_server_plug_init model, except only returns one
 868  *  sasl_canonuser_plug_t structure;
 869  */
 870 typedef int sasl_canonuser_init_t(const sasl_utils_t *utils,
 871                                   int max_version,
 872                                   int *out_version,
 873                                   sasl_canonuser_plug_t **plug,
 874                                   const char *plugname);
 875
 876 /* add a canonuser plugin
 877  */
 878 LIBSASL_API int sasl_canonuser_add_plugin(const char *plugname,
 879                                   sasl_canonuser_init_t *canonuserfunc);
 880
 881 /******************************************************
 882  * auxiliary property plug-in -- added cjn 1999-09-29 *
 883  ******************************************************/
 884
 885 typedef struct sasl_auxprop_plug {
 886     /* optional features of plugin (none defined yet, set to 0) */
 887     int features;
 888
 889     /* spare integer, must be set to 0 */
 890     int spare_int1;
 891
 892     /* global state for plugin */
 893     void *glob_context;
 894
 895     /* free global state for plugin (OPTIONAL) */
 896     void (*auxprop_free)(void *glob_context, const sasl_utils_t *utils);
 897
 898     /* fill in fields of an auxiliary property context
 899      *  last element in array has id of SASL_AUX_END
 900      *  elements with non-0 len should be ignored.
 901      */
 902     void (*auxprop_lookup)(void *glob_context,
 903                            sasl_server_params_t *sparams,
 904                            unsigned flags,
 905                            const char *user, unsigned ulen);
 906
 907     /* name of the auxprop plugin */
 908     char *name;
 909
 910     /* store the fields/values of an auxiliary property context (OPTIONAL)
 911      *
 912      * if ctx is NULL, just check if storing properties is enabled
 913      *
 914      * returns
 915      *  SASL_OK         on success
 916      *  SASL_FAIL       on failure
 917      */
 918     int (*auxprop_store)(void *glob_context,
 919                          sasl_server_params_t *sparams,
 920                          struct propctx *ctx,
 921                          const char *user, unsigned ulen);
 922 } sasl_auxprop_plug_t;
 923
 924 /* auxprop lookup flags */
 925 #define SASL_AUXPROP_OVERRIDE 0x01 /* if clear, ignore auxiliary properties
 926                                     * with non-zero len field.  If set,
 927                                     * override value of those properties */
 928 #define SASL_AUXPROP_AUTHZID  0x02 /* if clear, we are looking up the
 929                                     * authid flags (prefixed with *), otherwise
 930                                     * we are looking up the authzid flags
 931                                     * (no prefix) */
 932
 933 #define SASL_AUXPROP_PLUG_VERSION 4
 934
 935 /* default name for auxprop plug-in entry point is "sasl_auxprop_init"
 936  *  similar to sasl_server_plug_init model, except only returns one
 937  *  sasl_auxprop_plug_t structure;
 938  */
 939 typedef int sasl_auxprop_init_t(const sasl_utils_t *utils,
 940                                 int max_version,
 941                                 int *out_version,
 942                                 sasl_auxprop_plug_t **plug,
 943                                 const char *plugname);
 944
 945 /* add an auxiliary property plug-in
 946  */
 947 LIBSASL_API int sasl_auxprop_add_plugin(const char *plugname,
 948                                         sasl_auxprop_init_t *auxpropfunc);
 949
 950 typedef void auxprop_info_callback_t (sasl_auxprop_plug_t *m,
 951                                       sasl_info_callback_stage_t stage,
 952                                       void *rock);
 953
 954 /* Dump information about available auxprop plugins (separate functions are
 955    used for canon and server authentication plugins) */
 956 LIBSASL_API int auxprop_plugin_info (const char *mech_list,
 957         auxprop_info_callback_t *info_cb,
 958         void *info_cb_rock);
 959
 960 #ifdef __cplusplus
 961 }
 962 #endif
 963
 964 #endif /* SASLPLUG_H */