Imported Upstream version 1.15.1
[platform/upstream/krb5.git] / doc / appdev / refs / macros / index.rst
1 krb5 simple macros
2 =========================
3
4 Public
5 -------
6
7 .. toctree::
8    :maxdepth: 1
9
10    ADDRTYPE_ADDRPORT.rst
11    ADDRTYPE_CHAOS.rst
12    ADDRTYPE_DDP.rst
13    ADDRTYPE_INET.rst
14    ADDRTYPE_INET6.rst
15    ADDRTYPE_IPPORT.rst
16    ADDRTYPE_ISO.rst
17    ADDRTYPE_IS_LOCAL.rst
18    ADDRTYPE_NETBIOS.rst
19    ADDRTYPE_XNS.rst
20    AD_TYPE_EXTERNAL.rst
21    AD_TYPE_FIELD_TYPE_MASK.rst
22    AD_TYPE_REGISTERED.rst
23    AD_TYPE_RESERVED.rst
24    AP_OPTS_ETYPE_NEGOTIATION.rst
25    AP_OPTS_MUTUAL_REQUIRED.rst
26    AP_OPTS_RESERVED.rst
27    AP_OPTS_USE_SESSION_KEY.rst
28    AP_OPTS_USE_SUBKEY.rst
29    AP_OPTS_WIRE_MASK.rst
30    CKSUMTYPE_CMAC_CAMELLIA128.rst
31    CKSUMTYPE_CMAC_CAMELLIA256.rst
32    CKSUMTYPE_CRC32.rst
33    CKSUMTYPE_DESCBC.rst
34    CKSUMTYPE_HMAC_MD5_ARCFOUR.rst
35    CKSUMTYPE_HMAC_SHA1_96_AES128.rst
36    CKSUMTYPE_HMAC_SHA1_96_AES256.rst
37    CKSUMTYPE_HMAC_SHA256_128_AES128.rst
38    CKSUMTYPE_HMAC_SHA384_192_AES256.rst
39    CKSUMTYPE_HMAC_SHA1_DES3.rst
40    CKSUMTYPE_MD5_HMAC_ARCFOUR.rst
41    CKSUMTYPE_NIST_SHA.rst
42    CKSUMTYPE_RSA_MD4.rst
43    CKSUMTYPE_RSA_MD4_DES.rst
44    CKSUMTYPE_RSA_MD5.rst
45    CKSUMTYPE_RSA_MD5_DES.rst
46    ENCTYPE_AES128_CTS_HMAC_SHA1_96.rst
47    ENCTYPE_AES128_CTS_HMAC_SHA256_128.rst
48    ENCTYPE_AES256_CTS_HMAC_SHA1_96.rst
49    ENCTYPE_AES256_CTS_HMAC_SHA384_192.rst
50    ENCTYPE_ARCFOUR_HMAC.rst
51    ENCTYPE_ARCFOUR_HMAC_EXP.rst
52    ENCTYPE_CAMELLIA128_CTS_CMAC.rst
53    ENCTYPE_CAMELLIA256_CTS_CMAC.rst
54    ENCTYPE_DES3_CBC_ENV.rst
55    ENCTYPE_DES3_CBC_RAW.rst
56    ENCTYPE_DES3_CBC_SHA.rst
57    ENCTYPE_DES3_CBC_SHA1.rst
58    ENCTYPE_DES_CBC_CRC.rst
59    ENCTYPE_DES_CBC_MD4.rst
60    ENCTYPE_DES_CBC_MD5.rst
61    ENCTYPE_DES_CBC_RAW.rst
62    ENCTYPE_DES_HMAC_SHA1.rst
63    ENCTYPE_DSA_SHA1_CMS.rst
64    ENCTYPE_MD5_RSA_CMS.rst
65    ENCTYPE_NULL.rst
66    ENCTYPE_RC2_CBC_ENV.rst
67    ENCTYPE_RSA_ENV.rst
68    ENCTYPE_RSA_ES_OAEP_ENV.rst
69    ENCTYPE_SHA1_RSA_CMS.rst
70    ENCTYPE_UNKNOWN.rst
71    KDC_OPT_ALLOW_POSTDATE.rst
72    KDC_OPT_CANONICALIZE.rst
73    KDC_OPT_CNAME_IN_ADDL_TKT.rst
74    KDC_OPT_DISABLE_TRANSITED_CHECK.rst
75    KDC_OPT_ENC_TKT_IN_SKEY.rst
76    KDC_OPT_FORWARDABLE.rst
77    KDC_OPT_FORWARDED.rst
78    KDC_OPT_POSTDATED.rst
79    KDC_OPT_PROXIABLE.rst
80    KDC_OPT_PROXY.rst
81    KDC_OPT_RENEW.rst
82    KDC_OPT_RENEWABLE.rst
83    KDC_OPT_RENEWABLE_OK.rst
84    KDC_OPT_REQUEST_ANONYMOUS.rst
85    KDC_OPT_VALIDATE.rst
86    KDC_TKT_COMMON_MASK.rst
87    KRB5_ALTAUTH_ATT_CHALLENGE_RESPONSE.rst
88    KRB5_ANONYMOUS_PRINCSTR.rst
89    KRB5_ANONYMOUS_REALMSTR.rst
90    KRB5_AP_REP.rst
91    KRB5_AP_REQ.rst
92    KRB5_AS_REP.rst
93    KRB5_AS_REQ.rst
94    KRB5_AUTHDATA_AND_OR.rst
95    KRB5_AUTHDATA_AUTH_INDICATOR.rst
96    KRB5_AUTHDATA_CAMMAC.rst
97    KRB5_AUTHDATA_ETYPE_NEGOTIATION.rst
98    KRB5_AUTHDATA_FX_ARMOR.rst
99    KRB5_AUTHDATA_IF_RELEVANT.rst
100    KRB5_AUTHDATA_INITIAL_VERIFIED_CAS.rst
101    KRB5_AUTHDATA_KDC_ISSUED.rst
102    KRB5_AUTHDATA_MANDATORY_FOR_KDC.rst
103    KRB5_AUTHDATA_OSF_DCE.rst
104    KRB5_AUTHDATA_SESAME.rst
105    KRB5_AUTHDATA_SIGNTICKET.rst
106    KRB5_AUTHDATA_WIN2K_PAC.rst
107    KRB5_AUTH_CONTEXT_DO_SEQUENCE.rst
108    KRB5_AUTH_CONTEXT_DO_TIME.rst
109    KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR.rst
110    KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR.rst
111    KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR.rst
112    KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR.rst
113    KRB5_AUTH_CONTEXT_PERMIT_ALL.rst
114    KRB5_AUTH_CONTEXT_RET_SEQUENCE.rst
115    KRB5_AUTH_CONTEXT_RET_TIME.rst
116    KRB5_AUTH_CONTEXT_USE_SUBKEY.rst
117    KRB5_CRED.rst
118    KRB5_CRYPTO_TYPE_CHECKSUM.rst
119    KRB5_CRYPTO_TYPE_DATA.rst
120    KRB5_CRYPTO_TYPE_EMPTY.rst
121    KRB5_CRYPTO_TYPE_HEADER.rst
122    KRB5_CRYPTO_TYPE_PADDING.rst
123    KRB5_CRYPTO_TYPE_SIGN_ONLY.rst
124    KRB5_CRYPTO_TYPE_STREAM.rst
125    KRB5_CRYPTO_TYPE_TRAILER.rst
126    KRB5_CYBERSAFE_SECUREID.rst
127    KRB5_DOMAIN_X500_COMPRESS.rst
128    KRB5_ENCPADATA_REQ_ENC_PA_REP.rst
129    KRB5_ERROR.rst
130    KRB5_FAST_REQUIRED.rst
131    KRB5_GC_CACHED.rst
132    KRB5_GC_CANONICALIZE.rst
133    KRB5_GC_CONSTRAINED_DELEGATION.rst
134    KRB5_GC_FORWARDABLE.rst
135    KRB5_GC_NO_STORE.rst
136    KRB5_GC_NO_TRANSIT_CHECK.rst
137    KRB5_GC_USER_USER.rst
138    KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST.rst
139    KRB5_GET_INIT_CREDS_OPT_ANONYMOUS.rst
140    KRB5_GET_INIT_CREDS_OPT_CANONICALIZE.rst
141    KRB5_GET_INIT_CREDS_OPT_CHG_PWD_PRMPT.rst
142    KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST.rst
143    KRB5_GET_INIT_CREDS_OPT_FORWARDABLE.rst
144    KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST.rst
145    KRB5_GET_INIT_CREDS_OPT_PROXIABLE.rst
146    KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE.rst
147    KRB5_GET_INIT_CREDS_OPT_SALT.rst
148    KRB5_GET_INIT_CREDS_OPT_TKT_LIFE.rst
149    KRB5_INIT_CONTEXT_SECURE.rst
150    KRB5_INIT_CONTEXT_KDC.rst
151    KRB5_INIT_CREDS_STEP_FLAG_CONTINUE.rst
152    KRB5_INT16_MAX.rst
153    KRB5_INT16_MIN.rst
154    KRB5_INT32_MAX.rst
155    KRB5_INT32_MIN.rst
156    KRB5_KEYUSAGE_AD_ITE.rst
157    KRB5_KEYUSAGE_AD_KDCISSUED_CKSUM.rst
158    KRB5_KEYUSAGE_AD_MTE.rst
159    KRB5_KEYUSAGE_AD_SIGNEDPATH.rst
160    KRB5_KEYUSAGE_APP_DATA_CKSUM.rst
161    KRB5_KEYUSAGE_APP_DATA_ENCRYPT.rst
162    KRB5_KEYUSAGE_AP_REP_ENCPART.rst
163    KRB5_KEYUSAGE_AP_REQ_AUTH.rst
164    KRB5_KEYUSAGE_AP_REQ_AUTH_CKSUM.rst
165    KRB5_KEYUSAGE_AS_REP_ENCPART.rst
166    KRB5_KEYUSAGE_AS_REQ.rst
167    KRB5_KEYUSAGE_AS_REQ_PA_ENC_TS.rst
168    KRB5_KEYUSAGE_CAMMAC.rst
169    KRB5_KEYUSAGE_ENC_CHALLENGE_CLIENT.rst
170    KRB5_KEYUSAGE_ENC_CHALLENGE_KDC.rst
171    KRB5_KEYUSAGE_FAST_ENC.rst
172    KRB5_KEYUSAGE_FAST_FINISHED.rst
173    KRB5_KEYUSAGE_FAST_REP.rst
174    KRB5_KEYUSAGE_FAST_REQ_CHKSUM.rst
175    KRB5_KEYUSAGE_GSS_TOK_MIC.rst
176    KRB5_KEYUSAGE_GSS_TOK_WRAP_INTEG.rst
177    KRB5_KEYUSAGE_GSS_TOK_WRAP_PRIV.rst
178    KRB5_KEYUSAGE_IAKERB_FINISHED.rst
179    KRB5_KEYUSAGE_KDC_REP_TICKET.rst
180    KRB5_KEYUSAGE_KRB_CRED_ENCPART.rst
181    KRB5_KEYUSAGE_KRB_ERROR_CKSUM.rst
182    KRB5_KEYUSAGE_KRB_PRIV_ENCPART.rst
183    KRB5_KEYUSAGE_KRB_SAFE_CKSUM.rst
184    KRB5_KEYUSAGE_PA_FX_COOKIE.rst
185    KRB5_KEYUSAGE_PA_OTP_REQUEST.rst
186    KRB5_KEYUSAGE_PA_PKINIT_KX.rst
187    KRB5_KEYUSAGE_PA_S4U_X509_USER_REPLY.rst
188    KRB5_KEYUSAGE_PA_S4U_X509_USER_REQUEST.rst
189    KRB5_KEYUSAGE_PA_SAM_CHALLENGE_CKSUM.rst
190    KRB5_KEYUSAGE_PA_SAM_CHALLENGE_TRACKID.rst
191    KRB5_KEYUSAGE_PA_SAM_RESPONSE.rst
192    KRB5_KEYUSAGE_TGS_REP_ENCPART_SESSKEY.rst
193    KRB5_KEYUSAGE_TGS_REP_ENCPART_SUBKEY.rst
194    KRB5_KEYUSAGE_TGS_REQ_AD_SESSKEY.rst
195    KRB5_KEYUSAGE_TGS_REQ_AD_SUBKEY.rst
196    KRB5_KEYUSAGE_TGS_REQ_AUTH.rst
197    KRB5_KEYUSAGE_TGS_REQ_AUTH_CKSUM.rst
198    KRB5_KPASSWD_ACCESSDENIED.rst
199    KRB5_KPASSWD_AUTHERROR.rst
200    KRB5_KPASSWD_BAD_VERSION.rst
201    KRB5_KPASSWD_HARDERROR.rst
202    KRB5_KPASSWD_INITIAL_FLAG_NEEDED.rst
203    KRB5_KPASSWD_MALFORMED.rst
204    KRB5_KPASSWD_SOFTERROR.rst
205    KRB5_KPASSWD_SUCCESS.rst
206    KRB5_LRQ_ALL_ACCT_EXPTIME.rst
207    KRB5_LRQ_ALL_LAST_INITIAL.rst
208    KRB5_LRQ_ALL_LAST_RENEWAL.rst
209    KRB5_LRQ_ALL_LAST_REQ.rst
210    KRB5_LRQ_ALL_LAST_TGT.rst
211    KRB5_LRQ_ALL_LAST_TGT_ISSUED.rst
212    KRB5_LRQ_ALL_PW_EXPTIME.rst
213    KRB5_LRQ_NONE.rst
214    KRB5_LRQ_ONE_ACCT_EXPTIME.rst
215    KRB5_LRQ_ONE_LAST_INITIAL.rst
216    KRB5_LRQ_ONE_LAST_RENEWAL.rst
217    KRB5_LRQ_ONE_LAST_REQ.rst
218    KRB5_LRQ_ONE_LAST_TGT.rst
219    KRB5_LRQ_ONE_LAST_TGT_ISSUED.rst
220    KRB5_LRQ_ONE_PW_EXPTIME.rst
221    KRB5_NT_ENTERPRISE_PRINCIPAL.rst
222    KRB5_NT_ENT_PRINCIPAL_AND_ID.rst
223    KRB5_NT_MS_PRINCIPAL.rst
224    KRB5_NT_MS_PRINCIPAL_AND_ID.rst
225    KRB5_NT_PRINCIPAL.rst
226    KRB5_NT_SMTP_NAME.rst
227    KRB5_NT_SRV_HST.rst
228    KRB5_NT_SRV_INST.rst
229    KRB5_NT_SRV_XHST.rst
230    KRB5_NT_UID.rst
231    KRB5_NT_UNKNOWN.rst
232    KRB5_NT_WELLKNOWN.rst
233    KRB5_NT_X500_PRINCIPAL.rst
234    KRB5_PAC_CLIENT_INFO.rst
235    KRB5_PAC_CREDENTIALS_INFO.rst
236    KRB5_PAC_DELEGATION_INFO.rst
237    KRB5_PAC_LOGON_INFO.rst
238    KRB5_PAC_PRIVSVR_CHECKSUM.rst
239    KRB5_PAC_SERVER_CHECKSUM.rst
240    KRB5_PAC_UPN_DNS_INFO.rst
241    KRB5_PADATA_AFS3_SALT.rst
242    KRB5_PADATA_AP_REQ.rst
243    KRB5_PADATA_AS_CHECKSUM.rst
244    KRB5_PADATA_ENCRYPTED_CHALLENGE.rst
245    KRB5_PADATA_ENC_SANDIA_SECURID.rst
246    KRB5_PADATA_ENC_TIMESTAMP.rst
247    KRB5_PADATA_ENC_UNIX_TIME.rst
248    KRB5_PADATA_ETYPE_INFO.rst
249    KRB5_PADATA_ETYPE_INFO2.rst
250    KRB5_PADATA_FOR_USER.rst
251    KRB5_PADATA_FX_COOKIE.rst
252    KRB5_PADATA_FX_ERROR.rst
253    KRB5_PADATA_FX_FAST.rst
254    KRB5_PADATA_GET_FROM_TYPED_DATA.rst
255    KRB5_PADATA_NONE.rst
256    KRB5_PADATA_OSF_DCE.rst
257    KRB5_PADATA_OTP_CHALLENGE.rst
258    KRB5_PADATA_OTP_PIN_CHANGE.rst
259    KRB5_PADATA_OTP_REQUEST.rst
260    KRB5_PADATA_PAC_REQUEST.rst
261    KRB5_PADATA_PKINIT_KX.rst
262    KRB5_PADATA_PK_AS_REP.rst
263    KRB5_PADATA_PK_AS_REP_OLD.rst
264    KRB5_PADATA_PK_AS_REQ.rst
265    KRB5_PADATA_PK_AS_REQ_OLD.rst
266    KRB5_PADATA_PW_SALT.rst
267    KRB5_PADATA_REFERRAL.rst
268    KRB5_PADATA_S4U_X509_USER.rst
269    KRB5_PADATA_SAM_CHALLENGE.rst
270    KRB5_PADATA_SAM_CHALLENGE_2.rst
271    KRB5_PADATA_SAM_REDIRECT.rst
272    KRB5_PADATA_SAM_RESPONSE.rst
273    KRB5_PADATA_SAM_RESPONSE_2.rst
274    KRB5_PADATA_SESAME.rst
275    KRB5_PADATA_SVR_REFERRAL_INFO.rst
276    KRB5_PADATA_TGS_REQ.rst
277    KRB5_PADATA_USE_SPECIFIED_KVNO.rst
278    KRB5_PRINCIPAL_COMPARE_CASEFOLD.rst
279    KRB5_PRINCIPAL_COMPARE_ENTERPRISE.rst
280    KRB5_PRINCIPAL_COMPARE_IGNORE_REALM.rst
281    KRB5_PRINCIPAL_COMPARE_UTF8.rst
282    KRB5_PRINCIPAL_PARSE_ENTERPRISE.rst
283    KRB5_PRINCIPAL_PARSE_IGNORE_REALM.rst
284    KRB5_PRINCIPAL_PARSE_NO_REALM.rst
285    KRB5_PRINCIPAL_PARSE_REQUIRE_REALM.rst
286    KRB5_PRINCIPAL_UNPARSE_DISPLAY.rst
287    KRB5_PRINCIPAL_UNPARSE_NO_REALM.rst
288    KRB5_PRINCIPAL_UNPARSE_SHORT.rst
289    KRB5_PRIV.rst
290    KRB5_PROMPT_TYPE_NEW_PASSWORD.rst
291    KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN.rst
292    KRB5_PROMPT_TYPE_PASSWORD.rst
293    KRB5_PROMPT_TYPE_PREAUTH.rst
294    KRB5_PVNO.rst
295    KRB5_REALM_BRANCH_CHAR.rst
296    KRB5_RECVAUTH_BADAUTHVERS.rst
297    KRB5_RECVAUTH_SKIP_VERSION.rst
298    KRB5_REFERRAL_REALM.rst
299    KRB5_RESPONDER_PKINIT_FLAGS_TOKEN_USER_PIN_COUNT_LOW.rst
300    KRB5_RESPONDER_PKINIT_FLAGS_TOKEN_USER_PIN_FINAL_TRY.rst
301    KRB5_RESPONDER_PKINIT_FLAGS_TOKEN_USER_PIN_LOCKED.rst
302    KRB5_RESPONDER_QUESTION_PKINIT.rst
303    KRB5_RESPONDER_OTP_FLAGS_COLLECT_PIN.rst
304    KRB5_RESPONDER_OTP_FLAGS_COLLECT_TOKEN.rst
305    KRB5_RESPONDER_OTP_FLAGS_NEXTOTP.rst
306    KRB5_RESPONDER_OTP_FLAGS_SEPARATE_PIN.rst
307    KRB5_RESPONDER_OTP_FORMAT_ALPHANUMERIC.rst
308    KRB5_RESPONDER_OTP_FORMAT_DECIMAL.rst
309    KRB5_RESPONDER_OTP_FORMAT_HEXADECIMAL.rst
310    KRB5_RESPONDER_QUESTION_OTP.rst
311    KRB5_RESPONDER_QUESTION_PASSWORD.rst
312    KRB5_SAFE.rst
313    KRB5_SAM_MUST_PK_ENCRYPT_SAD.rst
314    KRB5_SAM_SEND_ENCRYPTED_SAD.rst
315    KRB5_SAM_USE_SAD_AS_KEY.rst
316    KRB5_TC_MATCH_2ND_TKT.rst
317    KRB5_TC_MATCH_AUTHDATA.rst
318    KRB5_TC_MATCH_FLAGS.rst
319    KRB5_TC_MATCH_FLAGS_EXACT.rst
320    KRB5_TC_MATCH_IS_SKEY.rst
321    KRB5_TC_MATCH_KTYPE.rst
322    KRB5_TC_MATCH_SRV_NAMEONLY.rst
323    KRB5_TC_MATCH_TIMES.rst
324    KRB5_TC_MATCH_TIMES_EXACT.rst
325    KRB5_TC_NOTICKET.rst
326    KRB5_TC_OPENCLOSE.rst
327    KRB5_TC_SUPPORTED_KTYPES.rst
328    KRB5_TGS_NAME.rst
329    KRB5_TGS_NAME_SIZE.rst
330    KRB5_TGS_REP.rst
331    KRB5_TGS_REQ.rst
332    KRB5_TKT_CREDS_STEP_FLAG_CONTINUE.rst
333    KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL.rst
334    KRB5_WELLKNOWN_NAMESTR.rst
335    LR_TYPE_INTERPRETATION_MASK.rst
336    LR_TYPE_THIS_SERVER_ONLY.rst
337    MAX_KEYTAB_NAME_LEN.rst
338    MSEC_DIRBIT.rst
339    MSEC_VAL_MASK.rst
340    SALT_TYPE_AFS_LENGTH.rst
341    SALT_TYPE_NO_LENGTH.rst
342    THREEPARAMOPEN.rst
343    TKT_FLG_ANONYMOUS.rst
344    TKT_FLG_ENC_PA_REP.rst
345    TKT_FLG_FORWARDABLE.rst
346    TKT_FLG_FORWARDED.rst
347    TKT_FLG_HW_AUTH.rst
348    TKT_FLG_INITIAL.rst
349    TKT_FLG_INVALID.rst
350    TKT_FLG_MAY_POSTDATE.rst
351    TKT_FLG_OK_AS_DELEGATE.rst
352    TKT_FLG_POSTDATED.rst
353    TKT_FLG_PRE_AUTH.rst
354    TKT_FLG_PROXIABLE.rst
355    TKT_FLG_PROXY.rst
356    TKT_FLG_RENEWABLE.rst
357    TKT_FLG_TRANSIT_POLICY_CHECKED.rst
358    VALID_INT_BITS.rst
359    VALID_UINT_BITS.rst
360    krb5_const.rst
361    krb5_princ_component.rst
362    krb5_princ_name.rst
363    krb5_princ_realm.rst
364    krb5_princ_set_realm.rst
365    krb5_princ_set_realm_data.rst
366    krb5_princ_set_realm_length.rst
367    krb5_princ_size.rst
368    krb5_princ_type.rst
369    krb5_roundup.rst
370    krb5_x.rst
371    krb5_xc.rst
372
373 Deprecated macros
374 ------------------------------
375
376 .. toctree::
377    :maxdepth: 1
378
379    krb524_convert_creds_kdc.rst
380    krb524_init_ets.rst