heimdal: Add parameter to windc_plugin to allow extended return codes.
[jelmer/samba4-debian.git] / source / heimdal / kdc / windc_plugin.h
1 /*
2  * Copyright (c) 2006 Kungliga Tekniska Högskolan
3  * (Royal Institute of Technology, Stockholm, Sweden). 
4  * All rights reserved. 
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met: 
9  *
10  * 1. Redistributions of source code must retain the above copyright 
11  *    notice, this list of conditions and the following disclaimer. 
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright 
14  *    notice, this list of conditions and the following disclaimer in the 
15  *    documentation and/or other materials provided with the distribution. 
16  *
17  * 3. Neither the name of the Institute nor the names of its contributors 
18  *    may be used to endorse or promote products derived from this software 
19  *    without specific prior written permission. 
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
31  * SUCH DAMAGE. 
32  */
33
34 /* $Id: windc_plugin.h 19798 2007-01-10 15:24:51Z lha $ */
35
36 #ifndef HEIMDAL_KRB5_PAC_PLUGIN_H
37 #define HEIMDAL_KRB5_PAC_PLUGIN_H 1
38
39 #include <krb5.h>
40
41 /*
42  * The PAC generate function should allocate a krb5_pac using
43  * krb5_pac_init and fill in the PAC structure for the principal using
44  * krb5_pac_add_buffer.
45  *
46  * The PAC verify function should verify all components in the PAC
47  * using krb5_pac_get_types and krb5_pac_get_buffer for all types.
48  *
49  * Check client access function check if the client is authorized.
50  */
51
52 struct hdb_entry_ex;
53
54 typedef krb5_error_code 
55 (*krb5plugin_windc_pac_generate)(void *, krb5_context,
56                                  struct hdb_entry_ex *, krb5_pac *);
57
58 typedef krb5_error_code 
59 (*krb5plugin_windc_pac_verify)(void *, krb5_context,
60                                const krb5_principal,
61                                struct hdb_entry_ex *, 
62                                struct hdb_entry_ex *,
63                                krb5_pac *);
64
65 typedef krb5_error_code 
66 (*krb5plugin_windc_client_access)(
67     void *, krb5_context, struct hdb_entry_ex *, KDC_REQ *, krb5_data *);
68
69
70 #define KRB5_WINDC_PLUGING_MINOR                2
71
72 typedef struct krb5plugin_windc_ftable {
73     int                 minor_version;
74     krb5_error_code     (*init)(krb5_context, void **);
75     void                (*fini)(void *);
76     krb5plugin_windc_pac_generate       pac_generate;
77     krb5plugin_windc_pac_verify         pac_verify;
78     krb5plugin_windc_client_access      client_access;
79 } krb5plugin_windc_ftable;
80
81 #endif /* HEIMDAL_KRB5_PAC_PLUGIN_H */
82