diff options
Diffstat (limited to 'doc/html/_sources/appdev/refs/types')
92 files changed, 3297 insertions, 0 deletions
diff --git a/doc/html/_sources/appdev/refs/types/index.txt b/doc/html/_sources/appdev/refs/types/index.txt new file mode 100644 index 000000000000..dc414cfdebe1 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/index.txt @@ -0,0 +1,109 @@ +krb5 types and structures +========================= + +Public +------- + +.. toctree:: + :maxdepth: 1 + + krb5_address.rst + krb5_addrtype.rst + krb5_ap_req.rst + krb5_ap_rep.rst + krb5_ap_rep_enc_part.rst + krb5_authdata.rst + krb5_authdatatype.rst + krb5_authenticator.rst + krb5_boolean.rst + krb5_checksum.rst + krb5_const_pointer.rst + krb5_const_principal.rst + krb5_cred.rst + krb5_cred_enc_part.rst + krb5_cred_info.rst + krb5_creds.rst + krb5_crypto_iov.rst + krb5_cryptotype.rst + krb5_data.rst + krb5_deltat.rst + krb5_enc_data.rst + krb5_enc_kdc_rep_part.rst + krb5_enc_tkt_part.rst + krb5_encrypt_block.rst + krb5_enctype.rst + krb5_error.rst + krb5_error_code.rst + krb5_expire_callback_func.rst + krb5_flags.rst + krb5_get_init_creds_opt.rst + krb5_gic_opt_pa_data.rst + krb5_int16.rst + krb5_int32.rst + krb5_kdc_rep.rst + krb5_kdc_req.rst + krb5_keyblock.rst + krb5_keytab_entry.rst + krb5_keyusage.rst + krb5_kt_cursor.rst + krb5_kvno.rst + krb5_last_req_entry.rst + krb5_magic.rst + krb5_mk_req_checksum_func.rst + krb5_msgtype.rst + krb5_octet.rst + krb5_pa_pac_req.rst + krb5_pa_server_referral_data.rst + krb5_pa_svr_referral_data.rst + krb5_pa_data.rst + krb5_pointer.rst + krb5_post_recv_fn.rst + krb5_pre_send_fn.rst + krb5_preauthtype.rst + krb5_principal.rst + krb5_principal_data.rst + krb5_const_principal.rst + krb5_prompt.rst + krb5_prompt_type.rst + krb5_prompter_fct.rst + krb5_pwd_data.rst + krb5_responder_context.rst + krb5_responder_fn.rst + krb5_responder_otp_challenge.rst + krb5_responder_otp_tokeninfo.rst + krb5_responder_pkinit_challenge.rst + krb5_responder_pkinit_identity.rst + krb5_response.rst + krb5_replay_data.rst + krb5_ticket.rst + krb5_ticket_times.rst + krb5_timestamp.rst + krb5_tkt_authent.rst + krb5_trace_callback.rst + krb5_trace_info.rst + krb5_transited.rst + krb5_typed_data.rst + krb5_ui_2.rst + krb5_ui_4.rst + krb5_verify_init_creds_opt.rst + passwd_phrase_element.rst + + +Internal +--------- + +.. toctree:: + :maxdepth: 1 + + krb5_auth_context.rst + krb5_cksumtype + krb5_context.rst + krb5_cc_cursor.rst + krb5_ccache.rst + krb5_cccol_cursor.rst + krb5_init_creds_context.rst + krb5_key.rst + krb5_keytab.rst + krb5_pac.rst + krb5_rcache.rst + krb5_tkt_creds_context.rst diff --git a/doc/html/_sources/appdev/refs/types/krb5_address.txt b/doc/html/_sources/appdev/refs/types/krb5_address.txt new file mode 100644 index 000000000000..1d65d712ab48 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_address.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-address-struct: + +krb5_address +============ + +.. +.. c:type:: krb5_address +.. + +Structure for address. + + + +Declaration +------------ + +typedef struct _krb5_address krb5_address + + +Members +--------- + + +.. c:member:: krb5_magic krb5_address.magic + + + + +.. c:member:: krb5_addrtype krb5_address.addrtype + + + + +.. c:member:: unsigned int krb5_address.length + + + + +.. c:member:: krb5_octet * krb5_address.contents + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_addrtype.txt b/doc/html/_sources/appdev/refs/types/krb5_addrtype.txt new file mode 100644 index 000000000000..d2dcbc85fb98 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_addrtype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-addrtype-struct: + +krb5_addrtype +============= + +.. +.. c:type:: krb5_addrtype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_addrtype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ap_rep.txt b/doc/html/_sources/appdev/refs/types/krb5_ap_rep.txt new file mode 100644 index 000000000000..f05a1139fa0b --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ap_rep.txt @@ -0,0 +1,35 @@ +.. highlightlang:: c + +.. _krb5-ap-rep-struct: + +krb5_ap_rep +=========== + +.. +.. c:type:: krb5_ap_rep +.. + +C representaton of AP-REP message. + +The server's response to a client's request for mutual authentication. + +Declaration +------------ + +typedef struct _krb5_ap_rep krb5_ap_rep + + +Members +--------- + + +.. c:member:: krb5_magic krb5_ap_rep.magic + + + + +.. c:member:: krb5_enc_data krb5_ap_rep.enc_part + + Ciphertext of ApRepEncPart. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ap_rep_enc_part.txt b/doc/html/_sources/appdev/refs/types/krb5_ap_rep_enc_part.txt new file mode 100644 index 000000000000..73b7b1559fef --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ap_rep_enc_part.txt @@ -0,0 +1,50 @@ +.. highlightlang:: c + +.. _krb5-ap-rep-enc-part-struct: + +krb5_ap_rep_enc_part +==================== + +.. +.. c:type:: krb5_ap_rep_enc_part +.. + +Cleartext that is encrypted and put into :c:type:`_krb5_ap_rep` . + + + +Declaration +------------ + +typedef struct _krb5_ap_rep_enc_part krb5_ap_rep_enc_part + + +Members +--------- + + +.. c:member:: krb5_magic krb5_ap_rep_enc_part.magic + + + + +.. c:member:: krb5_timestamp krb5_ap_rep_enc_part.ctime + + Client time, seconds portion. + + +.. c:member:: krb5_int32 krb5_ap_rep_enc_part.cusec + + Client time, microseconds portion. + + +.. c:member:: krb5_keyblock * krb5_ap_rep_enc_part.subkey + + Subkey (optional) + + +.. c:member:: krb5_ui_4 krb5_ap_rep_enc_part.seq_number + + Sequence number. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ap_req.txt b/doc/html/_sources/appdev/refs/types/krb5_ap_req.txt new file mode 100644 index 000000000000..9806c1729fdf --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ap_req.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-ap-req-struct: + +krb5_ap_req +=========== + +.. +.. c:type:: krb5_ap_req +.. + +Authentication header. + + + +Declaration +------------ + +typedef struct _krb5_ap_req krb5_ap_req + + +Members +--------- + + +.. c:member:: krb5_magic krb5_ap_req.magic + + + + +.. c:member:: krb5_flags krb5_ap_req.ap_options + + Requested options. + + +.. c:member:: krb5_ticket * krb5_ap_req.ticket + + Ticket. + + +.. c:member:: krb5_enc_data krb5_ap_req.authenticator + + Encrypted authenticator. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_auth_context.txt b/doc/html/_sources/appdev/refs/types/krb5_auth_context.txt new file mode 100644 index 000000000000..8266b6c6566f --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_auth_context.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-auth-context-struct: + +krb5_auth_context +================= + +.. +.. c:type:: krb5_auth_context +.. + + + + +Declaration +------------ + +typedef struct _krb5_auth_context\* krb5_auth_context + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_authdata.txt b/doc/html/_sources/appdev/refs/types/krb5_authdata.txt new file mode 100644 index 000000000000..ef4d4c13d754 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_authdata.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-authdata-struct: + +krb5_authdata +============= + +.. +.. c:type:: krb5_authdata +.. + +Structure for auth data. + + + +Declaration +------------ + +typedef struct _krb5_authdata krb5_authdata + + +Members +--------- + + +.. c:member:: krb5_magic krb5_authdata.magic + + + + +.. c:member:: krb5_authdatatype krb5_authdata.ad_type + + ADTYPE. + + +.. c:member:: unsigned int krb5_authdata.length + + Length of data. + + +.. c:member:: krb5_octet * krb5_authdata.contents + + Data. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_authdatatype.txt b/doc/html/_sources/appdev/refs/types/krb5_authdatatype.txt new file mode 100644 index 000000000000..933b168ebc42 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_authdatatype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-authdatatype-struct: + +krb5_authdatatype +================= + +.. +.. c:type:: krb5_authdatatype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_authdatatype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_authenticator.txt b/doc/html/_sources/appdev/refs/types/krb5_authenticator.txt new file mode 100644 index 000000000000..a0601400c79f --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_authenticator.txt @@ -0,0 +1,65 @@ +.. highlightlang:: c + +.. _krb5-authenticator-struct: + +krb5_authenticator +================== + +.. +.. c:type:: krb5_authenticator +.. + +Ticket authenticator. + +The C representation of an unencrypted authenticator. + +Declaration +------------ + +typedef struct _krb5_authenticator krb5_authenticator + + +Members +--------- + + +.. c:member:: krb5_magic krb5_authenticator.magic + + + + +.. c:member:: krb5_principal krb5_authenticator.client + + client name/realm + + +.. c:member:: krb5_checksum * krb5_authenticator.checksum + + checksum, includes type, optional + + +.. c:member:: krb5_int32 krb5_authenticator.cusec + + client usec portion + + +.. c:member:: krb5_timestamp krb5_authenticator.ctime + + client sec portion + + +.. c:member:: krb5_keyblock * krb5_authenticator.subkey + + true session key, optional + + +.. c:member:: krb5_ui_4 krb5_authenticator.seq_number + + sequence #, optional + + +.. c:member:: krb5_authdata ** krb5_authenticator.authorization_data + + authoriazation data + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_boolean.txt b/doc/html/_sources/appdev/refs/types/krb5_boolean.txt new file mode 100644 index 000000000000..6ee72b3ad2b9 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_boolean.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-boolean-struct: + +krb5_boolean +============ + +.. +.. c:type:: krb5_boolean +.. + + + + +Declaration +------------ + +typedef unsigned int krb5_boolean + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cc_cursor.txt b/doc/html/_sources/appdev/refs/types/krb5_cc_cursor.txt new file mode 100644 index 000000000000..a570794059dc --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cc_cursor.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-cc-cursor-struct: + +krb5_cc_cursor +============== + +.. +.. c:type:: krb5_cc_cursor +.. + +Cursor for sequential lookup. + + + +Declaration +------------ + +typedef krb5_pointer krb5_cc_cursor + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ccache.txt b/doc/html/_sources/appdev/refs/types/krb5_ccache.txt new file mode 100644 index 000000000000..4c96cc8e66a0 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ccache.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-ccache-struct: + +krb5_ccache +=========== + +.. +.. c:type:: krb5_ccache +.. + + + + +Declaration +------------ + +typedef struct _krb5_ccache\* krb5_ccache + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cccol_cursor.txt b/doc/html/_sources/appdev/refs/types/krb5_cccol_cursor.txt new file mode 100644 index 000000000000..20ee4e0f691c --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cccol_cursor.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-cccol-cursor-struct: + +krb5_cccol_cursor +================= + +.. +.. c:type:: krb5_cccol_cursor +.. + +Cursor for iterating over all ccaches. + + + +Declaration +------------ + +typedef struct _krb5_cccol_cursor\* krb5_cccol_cursor + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_checksum.txt b/doc/html/_sources/appdev/refs/types/krb5_checksum.txt new file mode 100644 index 000000000000..0e970fd6be68 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_checksum.txt @@ -0,0 +1,44 @@ +.. highlightlang:: c + +.. _krb5-checksum-struct: + +krb5_checksum +============= + +.. +.. c:type:: krb5_checksum +.. + + + + +Declaration +------------ + +typedef struct _krb5_checksum krb5_checksum + + +Members +--------- + + +.. c:member:: krb5_magic krb5_checksum.magic + + + + +.. c:member:: krb5_cksumtype krb5_checksum.checksum_type + + + + +.. c:member:: unsigned int krb5_checksum.length + + + + +.. c:member:: krb5_octet * krb5_checksum.contents + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cksumtype.txt b/doc/html/_sources/appdev/refs/types/krb5_cksumtype.txt new file mode 100644 index 000000000000..c901dfc406b8 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cksumtype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-cksumtype-struct: + +krb5_cksumtype +============== + +.. +.. c:type:: krb5_cksumtype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_cksumtype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_const_pointer.txt b/doc/html/_sources/appdev/refs/types/krb5_const_pointer.txt new file mode 100644 index 000000000000..05da0826be59 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_const_pointer.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-const-pointer-struct: + +krb5_const_pointer +================== + +.. +.. c:type:: krb5_const_pointer +.. + + + + +Declaration +------------ + +typedef void const\* krb5_const_pointer + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_const_principal.txt b/doc/html/_sources/appdev/refs/types/krb5_const_principal.txt new file mode 100644 index 000000000000..b30d3f70c135 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_const_principal.txt @@ -0,0 +1,50 @@ +.. highlightlang:: c + +.. _krb5-const-principal-struct: + +krb5_const_principal +==================== + +.. +.. c:type:: krb5_const_principal +.. + +Constant version of :c:type:`krb5_principal_data` . + + + +Declaration +------------ + +typedef const krb5_principal_data\* krb5_const_principal + + +Members +--------- + + +.. c:member:: krb5_magic krb5_const_principal.magic + + + + +.. c:member:: krb5_data krb5_const_principal.realm + + + + +.. c:member:: krb5_data * krb5_const_principal.data + + An array of strings. + + +.. c:member:: krb5_int32 krb5_const_principal.length + + + + +.. c:member:: krb5_int32 krb5_const_principal.type + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_context.txt b/doc/html/_sources/appdev/refs/types/krb5_context.txt new file mode 100644 index 000000000000..51bce12a9d09 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_context.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-context-struct: + +krb5_context +============ + +.. +.. c:type:: krb5_context +.. + + + + +Declaration +------------ + +typedef struct _krb5_context\* krb5_context + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cred.txt b/doc/html/_sources/appdev/refs/types/krb5_cred.txt new file mode 100644 index 000000000000..61f1691d4f46 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cred.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-cred-struct: + +krb5_cred +========= + +.. +.. c:type:: krb5_cred +.. + +Credentials data structure. + + + +Declaration +------------ + +typedef struct _krb5_cred krb5_cred + + +Members +--------- + + +.. c:member:: krb5_magic krb5_cred.magic + + + + +.. c:member:: krb5_ticket ** krb5_cred.tickets + + Tickets. + + +.. c:member:: krb5_enc_data krb5_cred.enc_part + + Encrypted part. + + +.. c:member:: krb5_cred_enc_part * krb5_cred.enc_part2 + + Unencrypted version, if available. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cred_enc_part.txt b/doc/html/_sources/appdev/refs/types/krb5_cred_enc_part.txt new file mode 100644 index 000000000000..eee6a8a3f3d2 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cred_enc_part.txt @@ -0,0 +1,60 @@ +.. highlightlang:: c + +.. _krb5-cred-enc-part-struct: + +krb5_cred_enc_part +================== + +.. +.. c:type:: krb5_cred_enc_part +.. + +Cleartext credentials information. + + + +Declaration +------------ + +typedef struct _krb5_cred_enc_part krb5_cred_enc_part + + +Members +--------- + + +.. c:member:: krb5_magic krb5_cred_enc_part.magic + + + + +.. c:member:: krb5_int32 krb5_cred_enc_part.nonce + + Nonce (optional) + + +.. c:member:: krb5_timestamp krb5_cred_enc_part.timestamp + + Generation time, seconds portion. + + +.. c:member:: krb5_int32 krb5_cred_enc_part.usec + + Generation time, microseconds portion. + + +.. c:member:: krb5_address * krb5_cred_enc_part.s_address + + Sender address (optional) + + +.. c:member:: krb5_address * krb5_cred_enc_part.r_address + + Recipient address (optional) + + +.. c:member:: krb5_cred_info ** krb5_cred_enc_part.ticket_info + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cred_info.txt b/doc/html/_sources/appdev/refs/types/krb5_cred_info.txt new file mode 100644 index 000000000000..20cb7998fb42 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cred_info.txt @@ -0,0 +1,60 @@ +.. highlightlang:: c + +.. _krb5-cred-info-struct: + +krb5_cred_info +============== + +.. +.. c:type:: krb5_cred_info +.. + +Credentials information inserted into *EncKrbCredPart* . + + + +Declaration +------------ + +typedef struct _krb5_cred_info krb5_cred_info + + +Members +--------- + + +.. c:member:: krb5_magic krb5_cred_info.magic + + + + +.. c:member:: krb5_keyblock * krb5_cred_info.session + + Session key used to encrypt ticket. + + +.. c:member:: krb5_principal krb5_cred_info.client + + Client principal and realm. + + +.. c:member:: krb5_principal krb5_cred_info.server + + Server principal and realm. + + +.. c:member:: krb5_flags krb5_cred_info.flags + + Ticket flags. + + +.. c:member:: krb5_ticket_times krb5_cred_info.times + + Auth, start, end, renew_till. + + +.. c:member:: krb5_address ** krb5_cred_info.caddrs + + Array of pointers to addrs (optional) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_creds.txt b/doc/html/_sources/appdev/refs/types/krb5_creds.txt new file mode 100644 index 000000000000..caa91fd180c7 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_creds.txt @@ -0,0 +1,80 @@ +.. highlightlang:: c + +.. _krb5-creds-struct: + +krb5_creds +========== + +.. +.. c:type:: krb5_creds +.. + +Credentials structure including ticket, session key, and lifetime info. + + + +Declaration +------------ + +typedef struct _krb5_creds krb5_creds + + +Members +--------- + + +.. c:member:: krb5_magic krb5_creds.magic + + + + +.. c:member:: krb5_principal krb5_creds.client + + client's principal identifier + + +.. c:member:: krb5_principal krb5_creds.server + + server's principal identifier + + +.. c:member:: krb5_keyblock krb5_creds.keyblock + + session encryption key info + + +.. c:member:: krb5_ticket_times krb5_creds.times + + lifetime info + + +.. c:member:: krb5_boolean krb5_creds.is_skey + + true if ticket is encrypted in another ticket's skey + + +.. c:member:: krb5_flags krb5_creds.ticket_flags + + flags in ticket + + +.. c:member:: krb5_address ** krb5_creds.addresses + + addrs in ticket + + +.. c:member:: krb5_data krb5_creds.ticket + + ticket string itself + + +.. c:member:: krb5_data krb5_creds.second_ticket + + second ticket, if related to ticket (via DUPLICATE-SKEY or ENC-TKT-IN-SKEY) + + +.. c:member:: krb5_authdata ** krb5_creds.authdata + + authorization data + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_crypto_iov.txt b/doc/html/_sources/appdev/refs/types/krb5_crypto_iov.txt new file mode 100644 index 000000000000..7ede1928b608 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_crypto_iov.txt @@ -0,0 +1,35 @@ +.. highlightlang:: c + +.. _krb5-crypto-iov-struct: + +krb5_crypto_iov +=============== + +.. +.. c:type:: krb5_crypto_iov +.. + +Structure to describe a region of text to be encrypted or decrypted. + +The *flags* member describes the type of the iov. The *data* member points to the memory that will be manipulated. All iov APIs take a pointer to the first element of an array of krb5_crypto_iov's along with the size of that array. Buffer contents are manipulated in-place; data is overwritten. Callers must allocate the right number of krb5_crypto_iov structures before calling into an iov API. + +Declaration +------------ + +typedef struct _krb5_crypto_iov krb5_crypto_iov + + +Members +--------- + + +.. c:member:: krb5_cryptotype krb5_crypto_iov.flags + + :c:data:`KRB5_CRYPTO_TYPE` type of the iov + + +.. c:member:: krb5_data krb5_crypto_iov.data + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_cryptotype.txt b/doc/html/_sources/appdev/refs/types/krb5_cryptotype.txt new file mode 100644 index 000000000000..8cc46bfa6d73 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_cryptotype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-cryptotype-struct: + +krb5_cryptotype +=============== + +.. +.. c:type:: krb5_cryptotype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_cryptotype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_data.txt b/doc/html/_sources/appdev/refs/types/krb5_data.txt new file mode 100644 index 000000000000..7bc2c0ec2e43 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_data.txt @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _krb5-data-struct: + +krb5_data +========= + +.. +.. c:type:: krb5_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_data krb5_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_data.magic + + + + +.. c:member:: unsigned int krb5_data.length + + + + +.. c:member:: char * krb5_data.data + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_deltat.txt b/doc/html/_sources/appdev/refs/types/krb5_deltat.txt new file mode 100644 index 000000000000..acc6193a04ff --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_deltat.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-deltat-struct: + +krb5_deltat +=========== + +.. +.. c:type:: krb5_deltat +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_deltat + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_enc_data.txt b/doc/html/_sources/appdev/refs/types/krb5_enc_data.txt new file mode 100644 index 000000000000..b5109f75c946 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_enc_data.txt @@ -0,0 +1,44 @@ +.. highlightlang:: c + +.. _krb5-enc-data-struct: + +krb5_enc_data +============= + +.. +.. c:type:: krb5_enc_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_enc_data krb5_enc_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_enc_data.magic + + + + +.. c:member:: krb5_enctype krb5_enc_data.enctype + + + + +.. c:member:: krb5_kvno krb5_enc_data.kvno + + + + +.. c:member:: krb5_data krb5_enc_data.ciphertext + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_enc_kdc_rep_part.txt b/doc/html/_sources/appdev/refs/types/krb5_enc_kdc_rep_part.txt new file mode 100644 index 000000000000..1c5f129a690e --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_enc_kdc_rep_part.txt @@ -0,0 +1,80 @@ +.. highlightlang:: c + +.. _krb5-enc-kdc-rep-part-struct: + +krb5_enc_kdc_rep_part +===================== + +.. +.. c:type:: krb5_enc_kdc_rep_part +.. + +C representation of *EncKDCRepPart* protocol message. + +This is the cleartext message that is encrypted and inserted in *KDC-REP* . + +Declaration +------------ + +typedef struct _krb5_enc_kdc_rep_part krb5_enc_kdc_rep_part + + +Members +--------- + + +.. c:member:: krb5_magic krb5_enc_kdc_rep_part.magic + + + + +.. c:member:: krb5_msgtype krb5_enc_kdc_rep_part.msg_type + + krb5 message type + + +.. c:member:: krb5_keyblock * krb5_enc_kdc_rep_part.session + + Session key. + + +.. c:member:: krb5_last_req_entry ** krb5_enc_kdc_rep_part.last_req + + Array of pointers to entries. + + +.. c:member:: krb5_int32 krb5_enc_kdc_rep_part.nonce + + Nonce from request. + + +.. c:member:: krb5_timestamp krb5_enc_kdc_rep_part.key_exp + + Expiration date. + + +.. c:member:: krb5_flags krb5_enc_kdc_rep_part.flags + + Ticket flags. + + +.. c:member:: krb5_ticket_times krb5_enc_kdc_rep_part.times + + Lifetime info. + + +.. c:member:: krb5_principal krb5_enc_kdc_rep_part.server + + Server's principal identifier. + + +.. c:member:: krb5_address ** krb5_enc_kdc_rep_part.caddrs + + Array of ptrs to addrs, optional. + + +.. c:member:: krb5_pa_data ** krb5_enc_kdc_rep_part.enc_padata + + Encrypted preauthentication data. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_enc_tkt_part.txt b/doc/html/_sources/appdev/refs/types/krb5_enc_tkt_part.txt new file mode 100644 index 000000000000..8079fb4ff456 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_enc_tkt_part.txt @@ -0,0 +1,65 @@ +.. highlightlang:: c + +.. _krb5-enc-tkt-part-struct: + +krb5_enc_tkt_part +================= + +.. +.. c:type:: krb5_enc_tkt_part +.. + +Encrypted part of ticket. + + + +Declaration +------------ + +typedef struct _krb5_enc_tkt_part krb5_enc_tkt_part + + +Members +--------- + + +.. c:member:: krb5_magic krb5_enc_tkt_part.magic + + + + +.. c:member:: krb5_flags krb5_enc_tkt_part.flags + + flags + + +.. c:member:: krb5_keyblock * krb5_enc_tkt_part.session + + session key: includes enctype + + +.. c:member:: krb5_principal krb5_enc_tkt_part.client + + client name/realm + + +.. c:member:: krb5_transited krb5_enc_tkt_part.transited + + list of transited realms + + +.. c:member:: krb5_ticket_times krb5_enc_tkt_part.times + + auth, start, end, renew_till + + +.. c:member:: krb5_address ** krb5_enc_tkt_part.caddrs + + array of ptrs to addresses + + +.. c:member:: krb5_authdata ** krb5_enc_tkt_part.authorization_data + + auth data + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_encrypt_block.txt b/doc/html/_sources/appdev/refs/types/krb5_encrypt_block.txt new file mode 100644 index 000000000000..5b83893cd0a8 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_encrypt_block.txt @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _krb5-encrypt-block-struct: + +krb5_encrypt_block +================== + +.. +.. c:type:: krb5_encrypt_block +.. + + + + +Declaration +------------ + +typedef struct _krb5_encrypt_block krb5_encrypt_block + + +Members +--------- + + +.. c:member:: krb5_magic krb5_encrypt_block.magic + + + + +.. c:member:: krb5_enctype krb5_encrypt_block.crypto_entry + + + + +.. c:member:: krb5_keyblock * krb5_encrypt_block.key + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_enctype.txt b/doc/html/_sources/appdev/refs/types/krb5_enctype.txt new file mode 100644 index 000000000000..bd1544548f50 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_enctype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-enctype-struct: + +krb5_enctype +============ + +.. +.. c:type:: krb5_enctype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_enctype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_error.txt b/doc/html/_sources/appdev/refs/types/krb5_error.txt new file mode 100644 index 000000000000..a160da5423d2 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_error.txt @@ -0,0 +1,75 @@ +.. highlightlang:: c + +.. _krb5-error-struct: + +krb5_error +========== + +.. +.. c:type:: krb5_error +.. + +Error message structure. + + + +Declaration +------------ + +typedef struct _krb5_error krb5_error + + +Members +--------- + + +.. c:member:: krb5_magic krb5_error.magic + + + + +.. c:member:: krb5_timestamp krb5_error.ctime + + Client sec portion; optional. + + +.. c:member:: krb5_int32 krb5_error.cusec + + Client usec portion; optional. + + +.. c:member:: krb5_int32 krb5_error.susec + + Server usec portion. + + +.. c:member:: krb5_timestamp krb5_error.stime + + Server sec portion. + + +.. c:member:: krb5_ui_4 krb5_error.error + + Error code (protocol error #'s) + + +.. c:member:: krb5_principal krb5_error.client + + Client principal and realm. + + +.. c:member:: krb5_principal krb5_error.server + + Server principal and realm. + + +.. c:member:: krb5_data krb5_error.text + + Descriptive text. + + +.. c:member:: krb5_data krb5_error.e_data + + Additional error-describing data. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_error_code.txt b/doc/html/_sources/appdev/refs/types/krb5_error_code.txt new file mode 100644 index 000000000000..60a3b728e0f3 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_error_code.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-error-code-struct: + +krb5_error_code +=============== + +.. +.. c:type:: krb5_error_code +.. + +Used to convey an operation status. + +The value 0 indicates success; any other values are com_err codes. Use :c:func:`krb5_get_error_message()` to obtain a string describing the error. + +Declaration +------------ + +typedef krb5_int32 krb5_error_code + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_expire_callback_func.txt b/doc/html/_sources/appdev/refs/types/krb5_expire_callback_func.txt new file mode 100644 index 000000000000..81acfe2f5a75 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_expire_callback_func.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-expire-callback-func-struct: + +krb5_expire_callback_func +========================= + +.. +.. c:type:: krb5_expire_callback_func +.. + + + + +Declaration +------------ + +typedef void( \* krb5_expire_callback_func)(krb5_context context, void \*data, krb5_timestamp password_expiration, krb5_timestamp account_expiration, krb5_boolean is_last_req) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_flags.txt b/doc/html/_sources/appdev/refs/types/krb5_flags.txt new file mode 100644 index 000000000000..0efb2046ca40 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_flags.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-flags-struct: + +krb5_flags +========== + +.. +.. c:type:: krb5_flags +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_flags + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_get_init_creds_opt.txt b/doc/html/_sources/appdev/refs/types/krb5_get_init_creds_opt.txt new file mode 100644 index 000000000000..52e8e36a170b --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_get_init_creds_opt.txt @@ -0,0 +1,80 @@ +.. highlightlang:: c + +.. _krb5-get-init-creds-opt-struct: + +krb5_get_init_creds_opt +======================= + +.. +.. c:type:: krb5_get_init_creds_opt +.. + +Store options for *_krb5_get_init_creds* . + + + +Declaration +------------ + +typedef struct _krb5_get_init_creds_opt krb5_get_init_creds_opt + + +Members +--------- + + +.. c:member:: krb5_flags krb5_get_init_creds_opt.flags + + + + +.. c:member:: krb5_deltat krb5_get_init_creds_opt.tkt_life + + + + +.. c:member:: krb5_deltat krb5_get_init_creds_opt.renew_life + + + + +.. c:member:: int krb5_get_init_creds_opt.forwardable + + + + +.. c:member:: int krb5_get_init_creds_opt.proxiable + + + + +.. c:member:: krb5_enctype * krb5_get_init_creds_opt.etype_list + + + + +.. c:member:: int krb5_get_init_creds_opt.etype_list_length + + + + +.. c:member:: krb5_address ** krb5_get_init_creds_opt.address_list + + + + +.. c:member:: krb5_preauthtype * krb5_get_init_creds_opt.preauth_list + + + + +.. c:member:: int krb5_get_init_creds_opt.preauth_list_length + + + + +.. c:member:: krb5_data * krb5_get_init_creds_opt.salt + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_gic_opt_pa_data.txt b/doc/html/_sources/appdev/refs/types/krb5_gic_opt_pa_data.txt new file mode 100644 index 000000000000..665e3cd05b55 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_gic_opt_pa_data.txt @@ -0,0 +1,35 @@ +.. highlightlang:: c + +.. _krb5-gic-opt-pa-data-struct: + +krb5_gic_opt_pa_data +==================== + +.. +.. c:type:: krb5_gic_opt_pa_data +.. + +Generic preauth option attribute/value pairs. + + + +Declaration +------------ + +typedef struct _krb5_gic_opt_pa_data krb5_gic_opt_pa_data + + +Members +--------- + + +.. c:member:: char * krb5_gic_opt_pa_data.attr + + + + +.. c:member:: char * krb5_gic_opt_pa_data.value + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_init_creds_context.txt b/doc/html/_sources/appdev/refs/types/krb5_init_creds_context.txt new file mode 100644 index 000000000000..73be70af14c0 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_init_creds_context.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-init-creds-context-struct: + +krb5_init_creds_context +======================= + +.. +.. c:type:: krb5_init_creds_context +.. + + + + +Declaration +------------ + +typedef struct _krb5_init_creds_context\* krb5_init_creds_context + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_int16.txt b/doc/html/_sources/appdev/refs/types/krb5_int16.txt new file mode 100644 index 000000000000..06ca8e603e66 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_int16.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-int16-struct: + +krb5_int16 +========== + +.. +.. c:type:: krb5_int16 +.. + + + + +Declaration +------------ + +typedef int16_t krb5_int16 + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_int32.txt b/doc/html/_sources/appdev/refs/types/krb5_int32.txt new file mode 100644 index 000000000000..b97596f42c7d --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_int32.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-int32-struct: + +krb5_int32 +========== + +.. +.. c:type:: krb5_int32 +.. + + + + +Declaration +------------ + +typedef int32_t krb5_int32 + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_kdc_rep.txt b/doc/html/_sources/appdev/refs/types/krb5_kdc_rep.txt new file mode 100644 index 000000000000..5071a8fa3e80 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_kdc_rep.txt @@ -0,0 +1,60 @@ +.. highlightlang:: c + +.. _krb5-kdc-rep-struct: + +krb5_kdc_rep +============ + +.. +.. c:type:: krb5_kdc_rep +.. + +Representation of the *KDC-REP* protocol message. + + + +Declaration +------------ + +typedef struct _krb5_kdc_rep krb5_kdc_rep + + +Members +--------- + + +.. c:member:: krb5_magic krb5_kdc_rep.magic + + + + +.. c:member:: krb5_msgtype krb5_kdc_rep.msg_type + + KRB5_AS_REP or KRB5_KDC_REP. + + +.. c:member:: krb5_pa_data ** krb5_kdc_rep.padata + + Preauthentication data from KDC. + + +.. c:member:: krb5_principal krb5_kdc_rep.client + + Client principal and realm. + + +.. c:member:: krb5_ticket * krb5_kdc_rep.ticket + + Ticket. + + +.. c:member:: krb5_enc_data krb5_kdc_rep.enc_part + + Encrypted part of reply. + + +.. c:member:: krb5_enc_kdc_rep_part * krb5_kdc_rep.enc_part2 + + Unencrypted version, if available. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_kdc_req.txt b/doc/html/_sources/appdev/refs/types/krb5_kdc_req.txt new file mode 100644 index 000000000000..be8af1340dcb --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_kdc_req.txt @@ -0,0 +1,105 @@ +.. highlightlang:: c + +.. _krb5-kdc-req-struct: + +krb5_kdc_req +============ + +.. +.. c:type:: krb5_kdc_req +.. + +C representation of KDC-REQ protocol message, including KDC-REQ-BODY. + + + +Declaration +------------ + +typedef struct _krb5_kdc_req krb5_kdc_req + + +Members +--------- + + +.. c:member:: krb5_magic krb5_kdc_req.magic + + + + +.. c:member:: krb5_msgtype krb5_kdc_req.msg_type + + KRB5_AS_REQ or KRB5_TGS_REQ. + + +.. c:member:: krb5_pa_data ** krb5_kdc_req.padata + + Preauthentication data. + + +.. c:member:: krb5_flags krb5_kdc_req.kdc_options + + Requested options. + + +.. c:member:: krb5_principal krb5_kdc_req.client + + Client principal and realm. + + +.. c:member:: krb5_principal krb5_kdc_req.server + + Server principal and realm. + + +.. c:member:: krb5_timestamp krb5_kdc_req.from + + Requested start time. + + +.. c:member:: krb5_timestamp krb5_kdc_req.till + + Requested end time. + + +.. c:member:: krb5_timestamp krb5_kdc_req.rtime + + Requested renewable end time. + + +.. c:member:: krb5_int32 krb5_kdc_req.nonce + + Nonce to match request and response. + + +.. c:member:: int krb5_kdc_req.nktypes + + Number of enctypes. + + +.. c:member:: krb5_enctype * krb5_kdc_req.ktype + + Requested enctypes. + + +.. c:member:: krb5_address ** krb5_kdc_req.addresses + + Requested addresses (optional) + + +.. c:member:: krb5_enc_data krb5_kdc_req.authorization_data + + Encrypted authz data (optional) + + +.. c:member:: krb5_authdata ** krb5_kdc_req.unenc_authdata + + Unencrypted authz data. + + +.. c:member:: krb5_ticket ** krb5_kdc_req.second_ticket + + Second ticket array (optional) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_key.txt b/doc/html/_sources/appdev/refs/types/krb5_key.txt new file mode 100644 index 000000000000..d662446ace7f --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_key.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-key-struct: + +krb5_key +======== + +.. +.. c:type:: krb5_key +.. + +Opaque identifier for a key. + +Use with the krb5_k APIs for better performance for repeated operations with the same key and usage. Key identifiers must not be used simultaneously within multiple threads, as they may contain mutable internal state and are not mutex-protected. + +Declaration +------------ + +typedef struct krb5_key_st\* krb5_key + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_keyblock.txt b/doc/html/_sources/appdev/refs/types/krb5_keyblock.txt new file mode 100644 index 000000000000..ee3ec76006cc --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_keyblock.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-keyblock-struct: + +krb5_keyblock +============= + +.. +.. c:type:: krb5_keyblock +.. + +Exposed contents of a key. + + + +Declaration +------------ + +typedef struct _krb5_keyblock krb5_keyblock + + +Members +--------- + + +.. c:member:: krb5_magic krb5_keyblock.magic + + + + +.. c:member:: krb5_enctype krb5_keyblock.enctype + + + + +.. c:member:: unsigned int krb5_keyblock.length + + + + +.. c:member:: krb5_octet * krb5_keyblock.contents + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_keytab.txt b/doc/html/_sources/appdev/refs/types/krb5_keytab.txt new file mode 100644 index 000000000000..c8b3e2601bc7 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_keytab.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-keytab-struct: + +krb5_keytab +=========== + +.. +.. c:type:: krb5_keytab +.. + + + + +Declaration +------------ + +typedef struct _krb5_kt\* krb5_keytab + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_keytab_entry.txt b/doc/html/_sources/appdev/refs/types/krb5_keytab_entry.txt new file mode 100644 index 000000000000..81c2be7f5a13 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_keytab_entry.txt @@ -0,0 +1,50 @@ +.. highlightlang:: c + +.. _krb5-keytab-entry-struct: + +krb5_keytab_entry +================= + +.. +.. c:type:: krb5_keytab_entry +.. + +A key table entry. + + + +Declaration +------------ + +typedef struct krb5_keytab_entry_st krb5_keytab_entry + + +Members +--------- + + +.. c:member:: krb5_magic krb5_keytab_entry.magic + + + + +.. c:member:: krb5_principal krb5_keytab_entry.principal + + Principal of this key. + + +.. c:member:: krb5_timestamp krb5_keytab_entry.timestamp + + Time entry written to keytable. + + +.. c:member:: krb5_kvno krb5_keytab_entry.vno + + Key version number. + + +.. c:member:: krb5_keyblock krb5_keytab_entry.key + + The secret key. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_keyusage.txt b/doc/html/_sources/appdev/refs/types/krb5_keyusage.txt new file mode 100644 index 000000000000..56885f787b07 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_keyusage.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-keyusage-struct: + +krb5_keyusage +============= + +.. +.. c:type:: krb5_keyusage +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_keyusage + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_kt_cursor.txt b/doc/html/_sources/appdev/refs/types/krb5_kt_cursor.txt new file mode 100644 index 000000000000..d08ea0039bbe --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_kt_cursor.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-kt-cursor-struct: + +krb5_kt_cursor +============== + +.. +.. c:type:: krb5_kt_cursor +.. + + + + +Declaration +------------ + +typedef krb5_pointer krb5_kt_cursor + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_kvno.txt b/doc/html/_sources/appdev/refs/types/krb5_kvno.txt new file mode 100644 index 000000000000..324ce12ca636 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_kvno.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-kvno-struct: + +krb5_kvno +========= + +.. +.. c:type:: krb5_kvno +.. + + + + +Declaration +------------ + +typedef unsigned int krb5_kvno + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_last_req_entry.txt b/doc/html/_sources/appdev/refs/types/krb5_last_req_entry.txt new file mode 100644 index 000000000000..d7e6378726a1 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_last_req_entry.txt @@ -0,0 +1,40 @@ +.. highlightlang:: c + +.. _krb5-last-req-entry-struct: + +krb5_last_req_entry +=================== + +.. +.. c:type:: krb5_last_req_entry +.. + +Last request entry. + + + +Declaration +------------ + +typedef struct _krb5_last_req_entry krb5_last_req_entry + + +Members +--------- + + +.. c:member:: krb5_magic krb5_last_req_entry.magic + + + + +.. c:member:: krb5_int32 krb5_last_req_entry.lr_type + + LR type. + + +.. c:member:: krb5_timestamp krb5_last_req_entry.value + + Timestamp. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_magic.txt b/doc/html/_sources/appdev/refs/types/krb5_magic.txt new file mode 100644 index 000000000000..3be2051db242 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_magic.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-magic-struct: + +krb5_magic +========== + +.. +.. c:type:: krb5_magic +.. + + + + +Declaration +------------ + +typedef krb5_error_code krb5_magic + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_mk_req_checksum_func.txt b/doc/html/_sources/appdev/refs/types/krb5_mk_req_checksum_func.txt new file mode 100644 index 000000000000..a8f34c8b2dd1 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_mk_req_checksum_func.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-mk-req-checksum-func-struct: + +krb5_mk_req_checksum_func +========================= + +.. +.. c:type:: krb5_mk_req_checksum_func +.. + +Type of function used as a callback to generate checksum data for mk_req. + + + +Declaration +------------ + +typedef krb5_error_code( \* krb5_mk_req_checksum_func)(krb5_context, krb5_auth_context, void \*, krb5_data \*\*) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_msgtype.txt b/doc/html/_sources/appdev/refs/types/krb5_msgtype.txt new file mode 100644 index 000000000000..5e93f24b77af --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_msgtype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-msgtype-struct: + +krb5_msgtype +============ + +.. +.. c:type:: krb5_msgtype +.. + + + + +Declaration +------------ + +typedef unsigned int krb5_msgtype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_octet.txt b/doc/html/_sources/appdev/refs/types/krb5_octet.txt new file mode 100644 index 000000000000..3ec5e33ddc72 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_octet.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-octet-struct: + +krb5_octet +========== + +.. +.. c:type:: krb5_octet +.. + + + + +Declaration +------------ + +typedef uint8_t krb5_octet + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pa_data.txt b/doc/html/_sources/appdev/refs/types/krb5_pa_data.txt new file mode 100644 index 000000000000..a594900e8718 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pa_data.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-pa-data-struct: + +krb5_pa_data +============ + +.. +.. c:type:: krb5_pa_data +.. + +Pre-authentication data. + + + +Declaration +------------ + +typedef struct _krb5_pa_data krb5_pa_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_pa_data.magic + + + + +.. c:member:: krb5_preauthtype krb5_pa_data.pa_type + + Preauthentication data type. + + +.. c:member:: unsigned int krb5_pa_data.length + + Length of data. + + +.. c:member:: krb5_octet * krb5_pa_data.contents + + Data. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pa_pac_req.txt b/doc/html/_sources/appdev/refs/types/krb5_pa_pac_req.txt new file mode 100644 index 000000000000..e62edad75f6c --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pa_pac_req.txt @@ -0,0 +1,29 @@ +.. highlightlang:: c + +.. _krb5-pa-pac-req-struct: + +krb5_pa_pac_req +=============== + +.. +.. c:type:: krb5_pa_pac_req +.. + + + + +Declaration +------------ + +typedef struct _krb5_pa_pac_req krb5_pa_pac_req + + +Members +--------- + + +.. c:member:: krb5_boolean krb5_pa_pac_req.include_pac + + TRUE if a PAC should be included in TGS-REP. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pa_server_referral_data.txt b/doc/html/_sources/appdev/refs/types/krb5_pa_server_referral_data.txt new file mode 100644 index 000000000000..59460d76c4e4 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pa_server_referral_data.txt @@ -0,0 +1,49 @@ +.. highlightlang:: c + +.. _krb5-pa-server-referral-data-struct: + +krb5_pa_server_referral_data +============================ + +.. +.. c:type:: krb5_pa_server_referral_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_pa_server_referral_data krb5_pa_server_referral_data + + +Members +--------- + + +.. c:member:: krb5_data * krb5_pa_server_referral_data.referred_realm + + + + +.. c:member:: krb5_principal krb5_pa_server_referral_data.true_principal_name + + + + +.. c:member:: krb5_principal krb5_pa_server_referral_data.requested_principal_name + + + + +.. c:member:: krb5_timestamp krb5_pa_server_referral_data.referral_valid_until + + + + +.. c:member:: krb5_checksum krb5_pa_server_referral_data.rep_cksum + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pa_svr_referral_data.txt b/doc/html/_sources/appdev/refs/types/krb5_pa_svr_referral_data.txt new file mode 100644 index 000000000000..ea31606e7403 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pa_svr_referral_data.txt @@ -0,0 +1,29 @@ +.. highlightlang:: c + +.. _krb5-pa-svr-referral-data-struct: + +krb5_pa_svr_referral_data +========================= + +.. +.. c:type:: krb5_pa_svr_referral_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_pa_svr_referral_data krb5_pa_svr_referral_data + + +Members +--------- + + +.. c:member:: krb5_principal krb5_pa_svr_referral_data.principal + + Referred name, only realm is required. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pac.txt b/doc/html/_sources/appdev/refs/types/krb5_pac.txt new file mode 100644 index 000000000000..9903e8e301e8 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pac.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-pac-struct: + +krb5_pac +======== + +.. +.. c:type:: krb5_pac +.. + +PAC data structure to convey authorization information. + + + +Declaration +------------ + +typedef struct krb5_pac_data\* krb5_pac + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pointer.txt b/doc/html/_sources/appdev/refs/types/krb5_pointer.txt new file mode 100644 index 000000000000..ff1588a551b3 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pointer.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-pointer-struct: + +krb5_pointer +============ + +.. +.. c:type:: krb5_pointer +.. + + + + +Declaration +------------ + +typedef void\* krb5_pointer + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_post_recv_fn.txt b/doc/html/_sources/appdev/refs/types/krb5_post_recv_fn.txt new file mode 100644 index 000000000000..ed37b017798d --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_post_recv_fn.txt @@ -0,0 +1,22 @@ +.. highlightlang:: c + +.. _krb5-post-recv-fn-struct: + +krb5_post_recv_fn +================= + +.. +.. c:type:: krb5_post_recv_fn +.. + +Hook function for inspecting or overriding KDC replies. + +If *code* is non-zero, KDC communication failed and *reply* should be ignored. The hook function may return *code* or a different error code, or may synthesize a reply by setting *new_reply_out* and return successfully. +The hook function should use :c:func:`krb5_copy_data()` to construct the value for *new_reply_out* , to ensure that it can be freed correctly by the library. + +Declaration +------------ + +typedef krb5_error_code( \* krb5_post_recv_fn)(krb5_context context, void \*data, krb5_error_code code, const krb5_data \*realm, const krb5_data \*message, const krb5_data \*reply, krb5_data \*\*new_reply_out) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pre_send_fn.txt b/doc/html/_sources/appdev/refs/types/krb5_pre_send_fn.txt new file mode 100644 index 000000000000..a0fa04fdcaaf --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pre_send_fn.txt @@ -0,0 +1,24 @@ +.. highlightlang:: c + +.. _krb5-pre-send-fn-struct: + +krb5_pre_send_fn +================ + +.. +.. c:type:: krb5_pre_send_fn +.. + +Hook function for inspecting or modifying messages sent to KDCs. + +If the hook function sets *reply_out* , *message* will not be sent to the KDC, and the given reply will used instead. +If the hook function sets *new_message_out* , the given message will be sent to the KDC in place of *message* . +If the hook function returns successfully without setting either output, *message* will be sent to the KDC normally. +The hook function should use :c:func:`krb5_copy_data()` to construct the value for *new_message_out* or *reply_out* , to ensure that it can be freed correctly by the library. + +Declaration +------------ + +typedef krb5_error_code( \* krb5_pre_send_fn)(krb5_context context, void \*data, const krb5_data \*realm, const krb5_data \*message, krb5_data \*\*new_message_out, krb5_data \*\*new_reply_out) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_preauthtype.txt b/doc/html/_sources/appdev/refs/types/krb5_preauthtype.txt new file mode 100644 index 000000000000..601c6dee329a --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_preauthtype.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-preauthtype-struct: + +krb5_preauthtype +================ + +.. +.. c:type:: krb5_preauthtype +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_preauthtype + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_principal.txt b/doc/html/_sources/appdev/refs/types/krb5_principal.txt new file mode 100644 index 000000000000..38c2e9a65206 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_principal.txt @@ -0,0 +1,49 @@ +.. highlightlang:: c + +.. _krb5-principal-struct: + +krb5_principal +============== + +.. +.. c:type:: krb5_principal +.. + + + + +Declaration +------------ + +typedef krb5_principal_data\* krb5_principal + + +Members +--------- + + +.. c:member:: krb5_magic krb5_principal.magic + + + + +.. c:member:: krb5_data krb5_principal.realm + + + + +.. c:member:: krb5_data * krb5_principal.data + + An array of strings. + + +.. c:member:: krb5_int32 krb5_principal.length + + + + +.. c:member:: krb5_int32 krb5_principal.type + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_principal_data.txt b/doc/html/_sources/appdev/refs/types/krb5_principal_data.txt new file mode 100644 index 000000000000..f094f9cc4e56 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_principal_data.txt @@ -0,0 +1,49 @@ +.. highlightlang:: c + +.. _krb5-principal-data-struct: + +krb5_principal_data +=================== + +.. +.. c:type:: krb5_principal_data +.. + + + + +Declaration +------------ + +typedef struct krb5_principal_data krb5_principal_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_principal_data.magic + + + + +.. c:member:: krb5_data krb5_principal_data.realm + + + + +.. c:member:: krb5_data * krb5_principal_data.data + + An array of strings. + + +.. c:member:: krb5_int32 krb5_principal_data.length + + + + +.. c:member:: krb5_int32 krb5_principal_data.type + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_prompt.txt b/doc/html/_sources/appdev/refs/types/krb5_prompt.txt new file mode 100644 index 000000000000..cfc16981d898 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_prompt.txt @@ -0,0 +1,40 @@ +.. highlightlang:: c + +.. _krb5-prompt-struct: + +krb5_prompt +=========== + +.. +.. c:type:: krb5_prompt +.. + +Text for prompt used in prompter callback function. + + + +Declaration +------------ + +typedef struct _krb5_prompt krb5_prompt + + +Members +--------- + + +.. c:member:: char * krb5_prompt.prompt + + The prompt to show to the user. + + +.. c:member:: int krb5_prompt.hidden + + Boolean; informative prompt or hidden (e.g. + PIN) + +.. c:member:: krb5_data * krb5_prompt.reply + + Must be allocated before call to prompt routine. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_prompt_type.txt b/doc/html/_sources/appdev/refs/types/krb5_prompt_type.txt new file mode 100644 index 000000000000..6495c65f5ceb --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_prompt_type.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-prompt-type-struct: + +krb5_prompt_type +================ + +.. +.. c:type:: krb5_prompt_type +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_prompt_type + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_prompter_fct.txt b/doc/html/_sources/appdev/refs/types/krb5_prompter_fct.txt new file mode 100644 index 000000000000..66b8f6d23bf4 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_prompter_fct.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-prompter-fct-struct: + +krb5_prompter_fct +================= + +.. +.. c:type:: krb5_prompter_fct +.. + +Pointer to a prompter callback function. + + + +Declaration +------------ + +typedef krb5_error_code( \* krb5_prompter_fct)(krb5_context context, void \*data, const char \*name, const char \*banner, int num_prompts, krb5_prompt prompts[]) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_pwd_data.txt b/doc/html/_sources/appdev/refs/types/krb5_pwd_data.txt new file mode 100644 index 000000000000..67c03f76230d --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_pwd_data.txt @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _krb5-pwd-data-struct: + +krb5_pwd_data +============= + +.. +.. c:type:: krb5_pwd_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_pwd_data krb5_pwd_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_pwd_data.magic + + + + +.. c:member:: int krb5_pwd_data.sequence_count + + + + +.. c:member:: passwd_phrase_element ** krb5_pwd_data.element + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_rcache.txt b/doc/html/_sources/appdev/refs/types/krb5_rcache.txt new file mode 100644 index 000000000000..43f17fe12529 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_rcache.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-rcache-struct: + +krb5_rcache +=========== + +.. +.. c:type:: krb5_rcache +.. + + + + +Declaration +------------ + +typedef struct krb5_rc_st\* krb5_rcache + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_replay_data.txt b/doc/html/_sources/appdev/refs/types/krb5_replay_data.txt new file mode 100644 index 000000000000..0008fa68f196 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_replay_data.txt @@ -0,0 +1,40 @@ +.. highlightlang:: c + +.. _krb5-replay-data-struct: + +krb5_replay_data +================ + +.. +.. c:type:: krb5_replay_data +.. + +Replay data. + +Sequence number and timestamp information output by :c:func:`krb5_rd_priv()` and :c:func:`krb5_rd_safe()` . + +Declaration +------------ + +typedef struct krb5_replay_data krb5_replay_data + + +Members +--------- + + +.. c:member:: krb5_timestamp krb5_replay_data.timestamp + + Timestamp, seconds portion. + + +.. c:member:: krb5_int32 krb5_replay_data.usec + + Timestamp, microseconds portion. + + +.. c:member:: krb5_ui_4 krb5_replay_data.seq + + Sequence number. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_context.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_context.txt new file mode 100644 index 000000000000..3a7eb217964b --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_context.txt @@ -0,0 +1,22 @@ +.. highlightlang:: c + +.. _krb5-responder-context-struct: + +krb5_responder_context +====================== + +.. +.. c:type:: krb5_responder_context +.. + +A container for a set of preauthentication questions and answers. + +A responder context is supplied by the krb5 authentication system to a :c:type:`krb5_responder_fn` callback. It contains a list of questions and can receive answers. Questions contained in a responder context can be listed using :c:func:`krb5_responder_list_questions()` , retrieved using :c:func:`krb5_responder_get_challenge()` , or answered using :c:func:`krb5_responder_set_answer()` . The form of a question's challenge and answer depend on the question name. + + +Declaration +------------ + +typedef struct krb5_responder_context_st\* krb5_responder_context + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_fn.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_fn.txt new file mode 100644 index 000000000000..8fcd2e241c27 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_fn.txt @@ -0,0 +1,21 @@ +.. highlightlang:: c + +.. _krb5-responder-fn-struct: + +krb5_responder_fn +================= + +.. +.. c:type:: krb5_responder_fn +.. + +Responder function for an initial credential exchange. + +If a required question is unanswered, the prompter may be called. + +Declaration +------------ + +typedef krb5_error_code( \* krb5_responder_fn)(krb5_context ctx, void \*data, krb5_responder_context rctx) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_otp_challenge.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_otp_challenge.txt new file mode 100644 index 000000000000..e46c7edf8924 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_otp_challenge.txt @@ -0,0 +1,34 @@ +.. highlightlang:: c + +.. _krb5-responder-otp-challenge-struct: + +krb5_responder_otp_challenge +============================ + +.. +.. c:type:: krb5_responder_otp_challenge +.. + + + + +Declaration +------------ + +typedef struct _krb5_responder_otp_challenge krb5_responder_otp_challenge + + +Members +--------- + + +.. c:member:: char * krb5_responder_otp_challenge.service + + + + +.. c:member:: krb5_responder_otp_tokeninfo ** krb5_responder_otp_challenge.tokeninfo + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_otp_tokeninfo.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_otp_tokeninfo.txt new file mode 100644 index 000000000000..8c5c4b8d28ae --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_otp_tokeninfo.txt @@ -0,0 +1,59 @@ +.. highlightlang:: c + +.. _krb5-responder-otp-tokeninfo-struct: + +krb5_responder_otp_tokeninfo +============================ + +.. +.. c:type:: krb5_responder_otp_tokeninfo +.. + + + + +Declaration +------------ + +typedef struct _krb5_responder_otp_tokeninfo krb5_responder_otp_tokeninfo + + +Members +--------- + + +.. c:member:: krb5_flags krb5_responder_otp_tokeninfo.flags + + + + +.. c:member:: krb5_int32 krb5_responder_otp_tokeninfo.format + + + + +.. c:member:: krb5_int32 krb5_responder_otp_tokeninfo.length + + + + +.. c:member:: char * krb5_responder_otp_tokeninfo.vendor + + + + +.. c:member:: char * krb5_responder_otp_tokeninfo.challenge + + + + +.. c:member:: char * krb5_responder_otp_tokeninfo.token_id + + + + +.. c:member:: char * krb5_responder_otp_tokeninfo.alg_id + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_challenge.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_challenge.txt new file mode 100644 index 000000000000..f309cfc6726d --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_challenge.txt @@ -0,0 +1,29 @@ +.. highlightlang:: c + +.. _krb5-responder-pkinit-challenge-struct: + +krb5_responder_pkinit_challenge +=============================== + +.. +.. c:type:: krb5_responder_pkinit_challenge +.. + + + + +Declaration +------------ + +typedef struct _krb5_responder_pkinit_challenge krb5_responder_pkinit_challenge + + +Members +--------- + + +.. c:member:: krb5_responder_pkinit_identity ** krb5_responder_pkinit_challenge.identities + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_identity.txt b/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_identity.txt new file mode 100644 index 000000000000..56f37226865c --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_responder_pkinit_identity.txt @@ -0,0 +1,34 @@ +.. highlightlang:: c + +.. _krb5-responder-pkinit-identity-struct: + +krb5_responder_pkinit_identity +============================== + +.. +.. c:type:: krb5_responder_pkinit_identity +.. + + + + +Declaration +------------ + +typedef struct _krb5_responder_pkinit_identity krb5_responder_pkinit_identity + + +Members +--------- + + +.. c:member:: char * krb5_responder_pkinit_identity.identity + + + + +.. c:member:: krb5_int32 krb5_responder_pkinit_identity.token_flags + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_response.txt b/doc/html/_sources/appdev/refs/types/krb5_response.txt new file mode 100644 index 000000000000..4876233a4d58 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_response.txt @@ -0,0 +1,49 @@ +.. highlightlang:: c + +.. _krb5-response-struct: + +krb5_response +============= + +.. +.. c:type:: krb5_response +.. + + + + +Declaration +------------ + +typedef struct _krb5_response krb5_response + + +Members +--------- + + +.. c:member:: krb5_magic krb5_response.magic + + + + +.. c:member:: krb5_octet krb5_response.message_type + + + + +.. c:member:: krb5_data krb5_response.response + + + + +.. c:member:: krb5_int32 krb5_response.expected_nonce + + + + +.. c:member:: krb5_timestamp krb5_response.request_time + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ticket.txt b/doc/html/_sources/appdev/refs/types/krb5_ticket.txt new file mode 100644 index 000000000000..2a809d4e66d4 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ticket.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-ticket-struct: + +krb5_ticket +=========== + +.. +.. c:type:: krb5_ticket +.. + +Ticket structure. + +The C representation of the ticket message, with a pointer to the C representation of the encrypted part. + +Declaration +------------ + +typedef struct _krb5_ticket krb5_ticket + + +Members +--------- + + +.. c:member:: krb5_magic krb5_ticket.magic + + + + +.. c:member:: krb5_principal krb5_ticket.server + + server name/realm + + +.. c:member:: krb5_enc_data krb5_ticket.enc_part + + encryption type, kvno, encrypted encoding + + +.. c:member:: krb5_enc_tkt_part * krb5_ticket.enc_part2 + + ptr to decrypted version, if available + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ticket_times.txt b/doc/html/_sources/appdev/refs/types/krb5_ticket_times.txt new file mode 100644 index 000000000000..57dab5d1b60b --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ticket_times.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-ticket-times-struct: + +krb5_ticket_times +================= + +.. +.. c:type:: krb5_ticket_times +.. + +Ticket start time, end time, and renewal duration. + + + +Declaration +------------ + +typedef struct _krb5_ticket_times krb5_ticket_times + + +Members +--------- + + +.. c:member:: krb5_timestamp krb5_ticket_times.authtime + + Time at which KDC issued the initial ticket that corresponds to this ticket. + + +.. c:member:: krb5_timestamp krb5_ticket_times.starttime + + optional in ticket, if not present, use *authtime* + + +.. c:member:: krb5_timestamp krb5_ticket_times.endtime + + Ticket expiration time. + + +.. c:member:: krb5_timestamp krb5_ticket_times.renew_till + + Latest time at which renewal of ticket can be valid. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_timestamp.txt b/doc/html/_sources/appdev/refs/types/krb5_timestamp.txt new file mode 100644 index 000000000000..e9263e49d1b7 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_timestamp.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-timestamp-struct: + +krb5_timestamp +============== + +.. +.. c:type:: krb5_timestamp +.. + + + + +Declaration +------------ + +typedef krb5_int32 krb5_timestamp + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_tkt_authent.txt b/doc/html/_sources/appdev/refs/types/krb5_tkt_authent.txt new file mode 100644 index 000000000000..307c63f1623a --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_tkt_authent.txt @@ -0,0 +1,45 @@ +.. highlightlang:: c + +.. _krb5-tkt-authent-struct: + +krb5_tkt_authent +================ + +.. +.. c:type:: krb5_tkt_authent +.. + +Ticket authentication data. + + + +Declaration +------------ + +typedef struct _krb5_tkt_authent krb5_tkt_authent + + +Members +--------- + + +.. c:member:: krb5_magic krb5_tkt_authent.magic + + + + +.. c:member:: krb5_ticket * krb5_tkt_authent.ticket + + + + +.. c:member:: krb5_authenticator * krb5_tkt_authent.authenticator + + + + +.. c:member:: krb5_flags krb5_tkt_authent.ap_options + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_tkt_creds_context.txt b/doc/html/_sources/appdev/refs/types/krb5_tkt_creds_context.txt new file mode 100644 index 000000000000..398d42f3bc94 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_tkt_creds_context.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-tkt-creds-context-struct: + +krb5_tkt_creds_context +====================== + +.. +.. c:type:: krb5_tkt_creds_context +.. + + + + +Declaration +------------ + +typedef struct _krb5_tkt_creds_context\* krb5_tkt_creds_context + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_trace_callback.txt b/doc/html/_sources/appdev/refs/types/krb5_trace_callback.txt new file mode 100644 index 000000000000..b3bff56b696a --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_trace_callback.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-trace-callback-struct: + +krb5_trace_callback +=================== + +.. +.. c:type:: krb5_trace_callback +.. + + + + +Declaration +------------ + +typedef void( \* krb5_trace_callback)(krb5_context context, const krb5_trace_info \*info, void \*cb_data) + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_trace_info.txt b/doc/html/_sources/appdev/refs/types/krb5_trace_info.txt new file mode 100644 index 000000000000..7f303b671d21 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_trace_info.txt @@ -0,0 +1,30 @@ +.. highlightlang:: c + +.. _krb5-trace-info-struct: + +krb5_trace_info +=============== + +.. +.. c:type:: krb5_trace_info +.. + +A wrapper for passing information to a *krb5_trace_callback* . + +Currently, it only contains the formatted message as determined the the format string and arguments of the tracing macro, but it may be extended to contain more fields in the future. + +Declaration +------------ + +typedef struct _krb5_trace_info krb5_trace_info + + +Members +--------- + + +.. c:member:: const char * krb5_trace_info.message + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_transited.txt b/doc/html/_sources/appdev/refs/types/krb5_transited.txt new file mode 100644 index 000000000000..596647984747 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_transited.txt @@ -0,0 +1,40 @@ +.. highlightlang:: c + +.. _krb5-transited-struct: + +krb5_transited +============== + +.. +.. c:type:: krb5_transited +.. + +Structure for transited encoding. + + + +Declaration +------------ + +typedef struct _krb5_transited krb5_transited + + +Members +--------- + + +.. c:member:: krb5_magic krb5_transited.magic + + + + +.. c:member:: krb5_octet krb5_transited.tr_type + + Transited encoding type. + + +.. c:member:: krb5_data krb5_transited.tr_contents + + Contents. + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_typed_data.txt b/doc/html/_sources/appdev/refs/types/krb5_typed_data.txt new file mode 100644 index 000000000000..e3555eba6984 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_typed_data.txt @@ -0,0 +1,44 @@ +.. highlightlang:: c + +.. _krb5-typed-data-struct: + +krb5_typed_data +=============== + +.. +.. c:type:: krb5_typed_data +.. + + + + +Declaration +------------ + +typedef struct _krb5_typed_data krb5_typed_data + + +Members +--------- + + +.. c:member:: krb5_magic krb5_typed_data.magic + + + + +.. c:member:: krb5_int32 krb5_typed_data.type + + + + +.. c:member:: unsigned int krb5_typed_data.length + + + + +.. c:member:: krb5_octet * krb5_typed_data.data + + + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ui_2.txt b/doc/html/_sources/appdev/refs/types/krb5_ui_2.txt new file mode 100644 index 000000000000..ce9c205bdca8 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ui_2.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-ui-2-struct: + +krb5_ui_2 +========= + +.. +.. c:type:: krb5_ui_2 +.. + + + + +Declaration +------------ + +typedef uint16_t krb5_ui_2 + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_ui_4.txt b/doc/html/_sources/appdev/refs/types/krb5_ui_4.txt new file mode 100644 index 000000000000..b41ecb4b04ab --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_ui_4.txt @@ -0,0 +1,20 @@ +.. highlightlang:: c + +.. _krb5-ui-4-struct: + +krb5_ui_4 +========= + +.. +.. c:type:: krb5_ui_4 +.. + + + + +Declaration +------------ + +typedef uint32_t krb5_ui_4 + + diff --git a/doc/html/_sources/appdev/refs/types/krb5_verify_init_creds_opt.txt b/doc/html/_sources/appdev/refs/types/krb5_verify_init_creds_opt.txt new file mode 100644 index 000000000000..eaefb198df36 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/krb5_verify_init_creds_opt.txt @@ -0,0 +1,34 @@ +.. highlightlang:: c + +.. _krb5-verify-init-creds-opt-struct: + +krb5_verify_init_creds_opt +========================== + +.. +.. c:type:: krb5_verify_init_creds_opt +.. + + + + +Declaration +------------ + +typedef struct _krb5_verify_init_creds_opt krb5_verify_init_creds_opt + + +Members +--------- + + +.. c:member:: krb5_flags krb5_verify_init_creds_opt.flags + + + + +.. c:member:: int krb5_verify_init_creds_opt.ap_req_nofail + + boolean + + diff --git a/doc/html/_sources/appdev/refs/types/passwd_phrase_element.txt b/doc/html/_sources/appdev/refs/types/passwd_phrase_element.txt new file mode 100644 index 000000000000..c4738c5e9662 --- /dev/null +++ b/doc/html/_sources/appdev/refs/types/passwd_phrase_element.txt @@ -0,0 +1,39 @@ +.. highlightlang:: c + +.. _passwd-phrase-element-struct: + +passwd_phrase_element +===================== + +.. +.. c:type:: passwd_phrase_element +.. + + + + +Declaration +------------ + +typedef struct _passwd_phrase_element passwd_phrase_element + + +Members +--------- + + +.. c:member:: krb5_magic passwd_phrase_element.magic + + + + +.. c:member:: krb5_data * passwd_phrase_element.passwd + + + + +.. c:member:: krb5_data * passwd_phrase_element.phrase + + + + |