asn1: Add a GitHub Markdown manual
[heimdal.git] / kdc / kdc_locl.h
blob86e6a712f452a1b891b71516fa938e071117bd62
1 /*
2 * Copyright (c) 1997-2005 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
35 * $Id$
38 #ifndef __KDC_LOCL_H__
39 #define __KDC_LOCL_H__
41 #include "headers.h"
43 typedef struct pk_client_params pk_client_params;
44 typedef struct gss_client_params gss_client_params;
46 #include <kdc-private.h>
48 #define FAST_EXPIRATION_TIME (3 * 60)
50 /* KFE == KDC_FIND_ETYPE */
51 #define KFE_IS_TGS 0x1
52 #define KFE_IS_PREAUTH 0x2
53 #define KFE_USE_CLIENT 0x4
55 #define heim_pcontext krb5_context
56 #define heim_pconfig krb5_kdc_configuration *
57 #include <heimbase-svc.h>
59 #define KDC_AUDIT_EATWHITE HEIM_SVC_AUDIT_EATWHITE
60 #define KDC_AUDIT_VIS HEIM_SVC_AUDIT_VIS
61 #define KDC_AUDIT_VISLAST HEIM_SVC_AUDIT_VISLAST
63 struct kdc_request_desc {
64 HEIM_SVC_REQUEST_DESC_COMMON_ELEMENTS;
67 struct kdc_patypes;
69 struct krb5_kdc_configuration {
70 KRB5_KDC_CONFIGURATION_COMMON_ELEMENTS;
72 int num_kdc_processes;
74 size_t max_datagram_reply_length;
76 time_t kdc_warn_pwexpire; /* time before expiration to print a warning */
78 unsigned int require_preauth : 1; /* require preauth for all principals */
79 unsigned int encode_as_rep_as_tgs_rep : 1; /* bug compatibility */
82 * Windows 2019 (and earlier versions) always sends the salt
83 * and Samba has testsuites that check this behaviour, so a
84 * Samba AD DC will set this flag to match the AS-REP packet
85 * exactly.
87 unsigned int force_include_pa_etype_salt : 1;
89 unsigned int tgt_use_strongest_session_key : 1;
90 unsigned int preauth_use_strongest_session_key : 1;
91 unsigned int svc_use_strongest_session_key : 1;
92 unsigned int use_strongest_server_key : 1;
94 unsigned int check_ticket_addresses : 1;
95 unsigned int warn_ticket_addresses : 1;
96 unsigned int allow_null_ticket_addresses : 1;
97 unsigned int allow_anonymous : 1;
98 unsigned int historical_anon_realm : 1;
99 unsigned int strict_nametypes : 1;
100 enum krb5_kdc_trpolicy trpolicy;
102 unsigned int require_pac : 1;
103 unsigned int enable_armored_pa_enc_timestamp : 1;
104 unsigned int enable_unarmored_pa_enc_timestamp : 1;
106 unsigned int enable_pkinit : 1;
107 unsigned int pkinit_princ_in_cert : 1;
108 const char *pkinit_kdc_identity;
109 const char *pkinit_kdc_anchors;
110 const char *pkinit_kdc_friendly_name;
111 const char *pkinit_kdc_ocsp_file;
112 char **pkinit_kdc_cert_pool;
113 char **pkinit_kdc_revoke;
114 int pkinit_dh_min_bits;
115 unsigned int pkinit_require_binding : 1;
116 unsigned int pkinit_allow_proxy_certs : 1;
117 unsigned int synthetic_clients : 1;
118 unsigned int pkinit_max_life_from_cert_extension : 1;
119 krb5_timestamp pkinit_max_life_from_cert;
120 krb5_timestamp pkinit_max_life_bound;
121 krb5_timestamp synthetic_clients_max_life;
122 krb5_timestamp synthetic_clients_max_renew;
124 int digests_allowed;
125 unsigned int enable_digest : 1;
127 unsigned int enable_kx509 : 1;
129 unsigned int enable_gss_preauth : 1;
130 unsigned int enable_gss_auth_data : 1;
131 gss_OID_set gss_mechanisms_allowed;
132 gss_OID_set gss_cross_realm_mechanisms_allowed;
136 struct astgs_request_desc {
137 HEIM_SVC_REQUEST_DESC_COMMON_ELEMENTS;
139 /* AS-REQ or TGS-REQ */
140 KDC_REQ req;
142 /* AS-REP or TGS-REP */
143 KDC_REP rep;
144 EncTicketPart et;
145 EncKDCRepPart ek;
147 /* client principal (AS) or TGT/S4U principal (TGS) */
148 krb5_principal client_princ;
149 hdb_entry *client;
150 HDB *clientdb;
151 krb5_principal canon_client_princ;
153 /* server principal */
154 krb5_principal server_princ;
155 HDB *serverdb;
156 hdb_entry *server;
158 /* presented ticket in TGS-REQ (unused by AS) */
159 krb5_principal krbtgt_princ;
160 hdb_entry *krbtgt;
161 HDB *krbtgtdb;
162 krb5_ticket *ticket;
164 krb5_keyblock reply_key;
166 krb5_pac pac;
167 uint64_t pac_attributes;
169 /* Only AS */
170 const struct kdc_patypes *pa_used;
172 /* PA methods can affect both the reply key and the session key (pkinit) */
173 krb5_enctype sessionetype;
174 krb5_keyblock session_key;
176 krb5_timestamp pa_endtime;
177 krb5_timestamp pa_max_life;
179 krb5_keyblock strengthen_key;
180 const Key *ticket_key;
182 /* only valid for tgs-req */
183 unsigned int rk_is_subkey : 1;
184 unsigned int fast_asserted : 1;
186 krb5_crypto armor_crypto;
187 hdb_entry *armor_server;
188 HDB *armor_serverdb;
189 krb5_ticket *armor_ticket;
190 Key *armor_key;
192 KDCFastState fast;
195 typedef struct kx509_req_context_desc {
196 HEIM_SVC_REQUEST_DESC_COMMON_ELEMENTS;
198 struct Kx509Request req;
199 Kx509CSRPlus csr_plus;
200 krb5_auth_context ac;
201 const char *realm; /* XXX Confusion: is this crealm or srealm? */
202 krb5_keyblock *key;
203 hx509_request csr;
204 krb5_times ticket_times;
205 unsigned int send_chain:1; /* Client expects a full chain */
206 unsigned int have_csr:1; /* Client sent a CSR */
207 } *kx509_req_context;
209 #undef heim_pconfig
210 #undef heim_pcontext
212 extern sig_atomic_t exit_flag;
213 extern size_t max_request_udp;
214 extern size_t max_request_tcp;
215 extern const char *request_log;
216 extern const char *port_str;
217 extern krb5_addresses explicit_addresses;
219 extern int enable_http;
221 extern int detach_from_console;
222 extern int daemon_child;
223 extern int do_bonjour;
225 extern int testing_flag;
227 extern const struct units _kdc_digestunits[];
229 #define KDC_LOG_FILE "kdc.log"
231 extern struct timeval _kdc_now;
232 #define kdc_time (_kdc_now.tv_sec)
234 extern char *runas_string;
235 extern char *chroot_string;
237 void
238 start_kdc(krb5_context context, krb5_kdc_configuration *config, const char *argv0);
240 krb5_kdc_configuration *
241 configure(krb5_context context, int argc, char **argv, int *optidx);
243 #ifdef __APPLE__
244 void bonjour_announce(krb5_context, krb5_kdc_configuration *);
245 #endif
247 /* no-copy setters */
249 #undef _KDC_REQUEST_GET_ACCESSOR
250 #undef _KDC_REQUEST_SET_ACCESSOR
252 #undef _KDC_REQUEST_GET_ACCESSOR_PTR
253 #undef _KDC_REQUEST_SET_ACCESSOR_PTR
254 #define _KDC_REQUEST_SET_ACCESSOR_PTR(R, T, t, f) \
255 void \
256 _kdc_request_set_ ## f ## _nocopy(R r, T *v);
258 #undef _KDC_REQUEST_GET_ACCESSOR_STRUCT
259 #undef _KDC_REQUEST_SET_ACCESSOR_STRUCT
260 #define _KDC_REQUEST_SET_ACCESSOR_STRUCT(R, T, t, f) \
261 void \
262 _kdc_request_set_ ## f ## _nocopy(R r, T *v);
264 #undef HEIMDAL_KDC_KDC_ACCESSORS_H
265 #include "kdc-accessors.h"
267 #endif /* __KDC_LOCL_H__ */