/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* krb5/authdata_plugin.h
*
* Copyright (C) 2007 Apple Inc. All Rights Reserved.
*
* Export of this software from the United States of America may
* require a specific license from the United States Government.
* It is the responsibility of any person or organization contemplating
* export to obtain such a license before exporting.
*
* WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
* distribute this software and its documentation for any purpose and
* without fee is hereby granted, provided that the above copyright
* notice appear in all copies and that both that copyright notice and
* this permission notice appear in supporting documentation, and that
* the name of M.I.T. not be used in advertising or publicity pertaining
* to distribution of the software without specific, written prior
* permission. Furthermore if you modify this software you must label
* your software as modified software and not distribute it in such a
* fashion that it might be confused with the original M.I.T. software.
* M.I.T. makes no representations about the suitability of
* this software for any purpose. It is provided "as is" without express
* or implied warranty.
*
* AuthorizationData plugin definitions for Kerberos 5.
*/
/*
* This is considered an INTERNAL interface at this time.
*
* Some work is needed before exporting it:
*
* + Documentation.
* + Sample code.
* + Test cases (preferably automated testing under "make check").
* + Hook into TGS exchange too; will change API.
* + Examine memory management issues, especially for Windows; may
* change API.
*
* Other changes that would be nice to have, but not necessarily
* before making this interface public:
*
* + Library support for AD-IF-RELEVANT and similar wrappers. (We can
* make the plugin construct them if it wants them.)
* + KDC could combine/optimize wrapped AD elements provided by
* multiple plugins, e.g., two IF-RELEVANT sequences could be
* merged. (The preauth plugin API also has this bug, we're going
* to need a general fix.)
*/
#ifndef KRB5_AUTHDATA_PLUGIN_H_INCLUDED
#define KRB5_AUTHDATA_PLUGIN_H_INCLUDED
#include <krb5.h>
/*
* While arguments of these types are passed-in, for the most part a
* authorization data module can treat them as opaque. If we need
* keying data, we can ask for it directly.
*/
struct _krb5_db_entry_new;
/*
* The function table / structure which an authdata server module must export as
* "authdata_server_0". NOTE: replace "0" with "1" for the type and
* variable names if this gets picked up by upstream. If the interfaces work
* correctly, future versions of the table will add either more callbacks or
* more arguments to callbacks, and in both cases we'll be able to wrap the v0
* functions.
*/
/* extern krb5plugin_authdata_ftable_v0 authdata_server_0; */
typedef struct krb5plugin_authdata_server_ftable_v0 {
/* Not-usually-visible name. */
char *name;
/*
* Per-plugin initialization/cleanup. The init function is called
* by the KDC when the plugin is loaded, and the fini function is
* called before the plugin is unloaded. Both are optional.
*/
krb5_error_code (*init_proc)(krb5_context, void **);
void (*fini_proc)(krb5_context, void *);
/*
* Actual authorization data handling function. If this field
* holds a null pointer, this mechanism will be skipped, and the
* init/fini functions will not be run.
*
* This function should only modify the field
* enc_tkt_reply->authorization_data. All other values should be
* considered inputs only. And, it should *modify* the field, not
* overwrite it and assume that there are no other authdata
* plugins in use.
*
* Memory management: authorization_data is a malloc-allocated,
* null-terminated sequence of malloc-allocated pointers to
* authorization data structures. This plugin code currently
* assumes the libraries, KDC, and plugin all use the same malloc
* pool, which may be a problem if/when we get the KDC code
* running on Windows.
*
* If this function returns a non-zero error code, a message
* is logged, but no other action is taken. Other authdata
* plugins will be called, and a response will be sent to the
* client (barring other problems).
*/
krb5_error_code (*authdata_proc)(krb5_context,
struct _krb5_db_entry_new *client,
krb5_data *req_pkt,
krb5_kdc_req *request,
krb5_enc_tkt_part *enc_tkt_reply);
} krb5plugin_server_authdata_ftable_v0;
typedef krb5plugin_server_authdata_ftable_v0 krb5plugin_authdata_ftable_v0;
typedef struct krb5plugin_authdata_server_ftable_v2 {
/* Not-usually-visible name. */
char *name;
/*
* Per-plugin initialization/cleanup. The init function is called
* by the KDC when the plugin is loaded, and the fini function is
* called before the plugin is unloaded. Both are optional.
*/
krb5_error_code (*init_proc)(krb5_context, void **);
void (*fini_proc)(krb5_context, void *);
/*
* Actual authorization data handling function. If this field
* holds a null pointer, this mechanism will be skipped, and the
* init/fini functions will not be run.
*
* This function should only modify the field
* enc_tkt_reply->authorization_data. All other values should be
* considered inputs only. And, it should *modify* the field, not
* overwrite it and assume that there are no other authdata
* plugins in use.
*
* Memory management: authorization_data is a malloc-allocated,
* null-terminated sequence of malloc-allocated pointers to
* authorization data structures. This plugin code currently
* assumes the libraries, KDC, and plugin all use the same malloc
* pool, which may be a problem if/when we get the KDC code
* running on Windows.
*
* If this function returns a non-zero error code, a message
* is logged, but no other action is taken. Other authdata
* plugins will be called, and a response will be sent to the
* client (barring other problems).
*/
krb5_error_code (*authdata_proc)(krb5_context,
unsigned int flags,
struct _krb5_db_entry_new *client,
struct _krb5_db_entry_new *server,
struct _krb5_db_entry_new *tgs,
krb5_keyblock *client_key,
krb5_keyblock *server_key,
krb5_keyblock *tgs_key,
krb5_data *req_pkt,
krb5_kdc_req *request,
krb5_const_principal for_user_princ,
krb5_enc_tkt_part *enc_tkt_request,
krb5_enc_tkt_part *enc_tkt_reply);
} krb5plugin_authdata_server_ftable_v2;
typedef krb5plugin_authdata_server_ftable_v2 krb5plugin_authdata_ftable_v2;
typedef krb5_error_code
(*authdata_client_plugin_init_proc)(krb5_context context,
void **plugin_context);
#define AD_USAGE_AS_REQ 0x01
#define AD_USAGE_TGS_REQ 0x02
#define AD_USAGE_AP_REQ 0x04
#define AD_USAGE_KDC_ISSUED 0x08
#define AD_USAGE_MASK 0x0F
#define AD_INFORMATIONAL 0x10
struct _krb5_authdata_context;
typedef void
(*authdata_client_plugin_flags_proc)(krb5_context kcontext,
void *plugin_context,
krb5_authdatatype ad_type,
krb5_flags *flags);
typedef void
(*authdata_client_plugin_fini_proc)(krb5_context kcontext,
void *plugin_context);
typedef krb5_error_code
(*authdata_client_request_init_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void **request_context);
typedef void
(*authdata_client_request_fini_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context);
typedef krb5_error_code
(*authdata_client_import_authdata_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_authdata **authdata,
krb5_boolean kdc_issued_flag,
krb5_const_principal issuer);
typedef krb5_error_code
(*authdata_client_export_authdata_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_flags usage,
krb5_authdata ***authdata);
typedef krb5_error_code
(*authdata_client_get_attribute_types_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_data **attrs);
typedef krb5_error_code
(*authdata_client_get_attribute_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
const krb5_data *attribute,
krb5_boolean *authenticated,
krb5_boolean *complete,
krb5_data *value,
krb5_data *display_value,
int *more);
typedef krb5_error_code
(*authdata_client_set_attribute_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_boolean complete,
const krb5_data *attribute,
const krb5_data *value);
typedef krb5_error_code
(*authdata_client_delete_attribute_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
const krb5_data *attribute);
typedef krb5_error_code
(*authdata_client_export_internal_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_boolean restrict_authenticated,
void **ptr);
typedef void
(*authdata_client_free_internal_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
void *ptr);
typedef krb5_error_code
(*authdata_client_verify_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
const krb5_auth_context *auth_context,
const krb5_keyblock *key,
const krb5_ap_req *req);
typedef krb5_error_code
(*authdata_client_size_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
size_t *sizep);
typedef krb5_error_code
(*authdata_client_externalize_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_octet **buffer,
size_t *lenremain);
typedef krb5_error_code
(*authdata_client_internalize_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
krb5_octet **buffer,
size_t *lenremain);
typedef krb5_error_code
(*authdata_client_copy_proc)(krb5_context kcontext,
struct _krb5_authdata_context *context,
void *plugin_context,
void *request_context,
void *dst_plugin_context,
void *dst_request_context);
typedef struct krb5plugin_authdata_client_ftable_v0 {
char *name;
krb5_authdatatype *ad_type_list;
authdata_client_plugin_init_proc init;
authdata_client_plugin_fini_proc fini;
authdata_client_plugin_flags_proc flags;
authdata_client_request_init_proc request_init;
authdata_client_request_fini_proc request_fini;
authdata_client_get_attribute_types_proc get_attribute_types;
authdata_client_get_attribute_proc get_attribute;
authdata_client_set_attribute_proc set_attribute;
authdata_client_delete_attribute_proc delete_attribute;
authdata_client_export_authdata_proc export_authdata;
authdata_client_import_authdata_proc import_authdata;
authdata_client_export_internal_proc export_internal;
authdata_client_free_internal_proc free_internal;
authdata_client_verify_proc verify;
authdata_client_size_proc size;
authdata_client_externalize_proc externalize;
authdata_client_internalize_proc internalize;
authdata_client_copy_proc copy; /* optional */
} krb5plugin_authdata_client_ftable_v0;
#endif /* KRB5_AUTHDATA_PLUGIN_H_INCLUDED */