€•“ƒ      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ/translations/zh_CN/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/zh_TW/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/it_IT/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ja_JP/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ko_KR/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/sp_SP/crypto/krb5”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒ9/var/lib/git/docbuild/linux/Documentation/crypto/krb5.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒKerberos V Cryptography API”h]”hŒKerberos V Cryptography API”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h Kubh¢)”}”(hŒóContents:

- Overview.
  - Small Buffer.
- Encoding Type.
- Key Derivation.
  - PRF+ Calculation.
  - Kc, Ke And Ki Derivation.
- Crypto Functions.
  - Preparation Functions.
  - Encryption Mode.
  - Checksum Mode.
- The krb5enc AEAD algorithm”h]”hŒóContents:

- Overview.
  - Small Buffer.
- Encoding Type.
- Key Derivation.
  - PRF+ Calculation.
  - Kc, Ke And Ki Derivation.
- Crypto Functions.
  - Preparation Functions.
  - Encryption Mode.
  - Checksum Mode.
- The krb5enc AEAD algorithm”…””}”hhÉsbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1h¡hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒOverview”h]”hŒOverview”…””}”(hhÚhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh×hžhhŸh³h KubhŒ	paragraph”“”)”}”(hŒÊThis API provides Kerberos 5-style cryptography for key derivation, encryption
and checksumming for use in network filesystems and can be used to implement
the low-level crypto that's needed for GSSAPI.”h]”hŒÌThis API provides Kerberos 5-style cryptography for key derivation, encryption
and checksumming for use in network filesystems and can be used to implement
the low-level crypto thatâ€™s needed for GSSAPI.”…””}”(hhêhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Khh×hžhubhé)”}”(hŒ*The following crypto types are supported::”h]”hŒ)The following crypto types are supported:”…””}”(hhøhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Khh×hžhubhŒliteral_block”“”)”}”(hX°  KRB5_ENCTYPE_AES128_CTS_HMAC_SHA1_96
KRB5_ENCTYPE_AES256_CTS_HMAC_SHA1_96
KRB5_ENCTYPE_AES128_CTS_HMAC_SHA256_128
KRB5_ENCTYPE_AES256_CTS_HMAC_SHA384_192
KRB5_ENCTYPE_CAMELLIA128_CTS_CMAC
KRB5_ENCTYPE_CAMELLIA256_CTS_CMAC

KRB5_CKSUMTYPE_HMAC_SHA1_96_AES128
KRB5_CKSUMTYPE_HMAC_SHA1_96_AES256
KRB5_CKSUMTYPE_CMAC_CAMELLIA128
KRB5_CKSUMTYPE_CMAC_CAMELLIA256
KRB5_CKSUMTYPE_HMAC_SHA256_128_AES128
KRB5_CKSUMTYPE_HMAC_SHA384_192_AES256”h]”hX°  KRB5_ENCTYPE_AES128_CTS_HMAC_SHA1_96
KRB5_ENCTYPE_AES256_CTS_HMAC_SHA1_96
KRB5_ENCTYPE_AES128_CTS_HMAC_SHA256_128
KRB5_ENCTYPE_AES256_CTS_HMAC_SHA384_192
KRB5_ENCTYPE_CAMELLIA128_CTS_CMAC
KRB5_ENCTYPE_CAMELLIA256_CTS_CMAC

KRB5_CKSUMTYPE_HMAC_SHA1_96_AES128
KRB5_CKSUMTYPE_HMAC_SHA1_96_AES256
KRB5_CKSUMTYPE_CMAC_CAMELLIA128
KRB5_CKSUMTYPE_CMAC_CAMELLIA256
KRB5_CKSUMTYPE_HMAC_SHA256_128_AES128
KRB5_CKSUMTYPE_HMAC_SHA384_192_AES256”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Khh×hžhubhé)”}”(hŒThe API can be included by::”h]”hŒThe API can be included by:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K,hh×hžhubj  )”}”(hŒ#include <crypto/krb5.h>”h]”hŒ#include <crypto/krb5.h>”…””}”hj$  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K.hh×hžhubhµ)”}”(hhh]”(hº)”}”(hŒSmall Buffer”h]”hŒSmall Buffer”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj2  hžhhŸh³h K1ubhé)”}”(hŒ‰To pass small pieces of data about, such as keys, a buffer structure is
defined, giving a pointer to the data and the size of that data::”h]”hŒˆTo pass small pieces of data about, such as keys, a buffer structure is
defined, giving a pointer to the data and the size of that data:”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K3hj2  hžhubj  )”}”(hŒSstruct krb5_buffer {
        unsigned int    len;
        void            *data;
};”h]”hŒSstruct krb5_buffer {
        unsigned int    len;
        void            *data;
};”…””}”hjQ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K6hj2  hžhubeh}”(h]”Œsmall-buffer”ah ]”h"]”Œsmall buffer”ah$]”h&]”uh1h´hh×hžhhŸh³h K1ubeh}”(h]”Œoverview”ah ]”h"]”Œoverview”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒEncoding Type”h]”hŒEncoding Type”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjo  hžhhŸh³h K<ubhé)”}”(hŒ9The encoding type is defined by the following structure::”h]”hŒ8The encoding type is defined by the following structure:”…””}”(hj€  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K>hjo  hžhubj  )”}”(hX®  struct krb5_enctype {
        int             etype;
        int             ctype;
        const char      *name;
        u16             key_bytes;
        u16             key_len;
        u16             Kc_len;
        u16             Ke_len;
        u16             Ki_len;
        u16             prf_len;
        u16             block_len;
        u16             conf_len;
        u16             cksum_len;
        ...
};”h]”hX®  struct krb5_enctype {
        int             etype;
        int             ctype;
        const char      *name;
        u16             key_bytes;
        u16             key_len;
        u16             Kc_len;
        u16             Ke_len;
        u16             Ki_len;
        u16             prf_len;
        u16             block_len;
        u16             conf_len;
        u16             cksum_len;
        ...
};”…””}”hjŽ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K@hjo  hžhubhé)”}”(hŒ=The fields of interest to the user of the API are as follows:”h]”hŒ=The fields of interest to the user of the API are as follows:”…””}”(hjœ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KPhjo  hžhubhŒblock_quote”“”)”}”(hXj  * ``etype`` and ``ctype`` indicate the protocol number for this encoding
  type for encryption and checksumming respectively.  They hold
  ``KRB5_ENCTYPE_*`` and ``KRB5_CKSUMTYPE_*`` constants.

* ``name`` is the formal name of the encoding.

* ``key_len`` and ``key_bytes`` are the input key length and the derived key
  length.  (I think they only differ for DES, which isn't supported here).

* ``Kc_len``, ``Ke_len`` and ``Ki_len`` are the sizes of the derived Kc, Ke
  and Ki keys.  Kc is used for in checksum mode; Ke and Ki are used in
  encryption mode.

* ``prf_len`` is the size of the result from the PRF+ function calculation.

* ``block_len``, ``conf_len`` and ``cksum_len`` are the encryption block
  length, confounder length and checksum length respectively.  All three are
  used in encryption mode, but only the checksum length is used in checksum
  mode.
”h]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ¼``etype`` and ``ctype`` indicate the protocol number for this encoding
type for encryption and checksumming respectively.  They hold
``KRB5_ENCTYPE_*`` and ``KRB5_CKSUMTYPE_*`` constants.
”h]”hé)”}”(hŒ»``etype`` and ``ctype`` indicate the protocol number for this encoding
type for encryption and checksumming respectively.  They hold
``KRB5_ENCTYPE_*`` and ``KRB5_CKSUMTYPE_*`` constants.”h]”(hŒliteral”“”)”}”(hŒ	``etype``”h]”hŒetype”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj»  ubhŒ and ”…””}”(hj»  hžhhŸNh NubjÀ  )”}”(hŒ	``ctype``”h]”hŒctype”…””}”(hjÓ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj»  ubhŒn indicate the protocol number for this encoding
type for encryption and checksumming respectively.  They hold
”…””}”(hj»  hžhhŸNh NubjÀ  )”}”(hŒ``KRB5_ENCTYPE_*``”h]”hŒKRB5_ENCTYPE_*”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj»  ubhŒ and ”…””}”hj»  sbjÀ  )”}”(hŒ``KRB5_CKSUMTYPE_*``”h]”hŒKRB5_CKSUMTYPE_*”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj»  ubhŒ constants.”…””}”(hj»  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KRhj·  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubj¶  )”}”(hŒ-``name`` is the formal name of the encoding.
”h]”hé)”}”(hŒ,``name`` is the formal name of the encoding.”h]”(jÀ  )”}”(hŒ``name``”h]”hŒname”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj  ubhŒ$ is the formal name of the encoding.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KVhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubj¶  )”}”(hŒ”``key_len`` and ``key_bytes`` are the input key length and the derived key
length.  (I think they only differ for DES, which isn't supported here).
”h]”hé)”}”(hŒ“``key_len`` and ``key_bytes`` are the input key length and the derived key
length.  (I think they only differ for DES, which isn't supported here).”h]”(jÀ  )”}”(hŒ``key_len``”h]”hŒkey_len”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj?  ubhŒ and ”…””}”(hj?  hžhhŸNh NubjÀ  )”}”(hŒ``key_bytes``”h]”hŒ	key_bytes”…””}”(hjU  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hj?  ubhŒx are the input key length and the derived key
length.  (I think they only differ for DES, which isnâ€™t supported here).”…””}”(hj?  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KXhj;  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubj¶  )”}”(hŒ ``Kc_len``, ``Ke_len`` and ``Ki_len`` are the sizes of the derived Kc, Ke
and Ki keys.  Kc is used for in checksum mode; Ke and Ki are used in
encryption mode.
”h]”hé)”}”(hŒŸ``Kc_len``, ``Ke_len`` and ``Ki_len`` are the sizes of the derived Kc, Ke
and Ki keys.  Kc is used for in checksum mode; Ke and Ki are used in
encryption mode.”h]”(jÀ  )”}”(hŒ
``Kc_len``”h]”hŒKc_len”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjw  ubhŒ, ”…””}”(hjw  hžhhŸNh NubjÀ  )”}”(hŒ
``Ke_len``”h]”hŒKe_len”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjw  ubhŒ and ”…””}”(hjw  hžhhŸNh NubjÀ  )”}”(hŒ
``Ki_len``”h]”hŒKi_len”…””}”(hjŸ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjw  ubhŒz are the sizes of the derived Kc, Ke
and Ki keys.  Kc is used for in checksum mode; Ke and Ki are used in
encryption mode.”…””}”(hjw  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K[hjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubj¶  )”}”(hŒJ``prf_len`` is the size of the result from the PRF+ function calculation.
”h]”hé)”}”(hŒI``prf_len`` is the size of the result from the PRF+ function calculation.”h]”(jÀ  )”}”(hŒ``prf_len``”h]”hŒprf_len”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjÁ  ubhŒ> is the size of the result from the PRF+ function calculation.”…””}”(hjÁ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K_hj½  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubj¶  )”}”(hŒâ``block_len``, ``conf_len`` and ``cksum_len`` are the encryption block
length, confounder length and checksum length respectively.  All three are
used in encryption mode, but only the checksum length is used in checksum
mode.
”h]”hé)”}”(hŒá``block_len``, ``conf_len`` and ``cksum_len`` are the encryption block
length, confounder length and checksum length respectively.  All three are
used in encryption mode, but only the checksum length is used in checksum
mode.”h]”(jÀ  )”}”(hŒ``block_len``”h]”hŒ	block_len”…””}”(hjë  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjç  ubhŒ, ”…””}”(hjç  hžhhŸNh NubjÀ  )”}”(hŒ``conf_len``”h]”hŒconf_len”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjç  ubhŒ and ”…””}”(hjç  hžhhŸNh NubjÀ  )”}”(hŒ``cksum_len``”h]”hŒ	cksum_len”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjç  ubhŒ´ are the encryption block
length, confounder length and checksum length respectively.  All three are
used in encryption mode, but only the checksum length is used in checksum
mode.”…””}”(hjç  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Kahjã  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jµ  hj²  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1j°  hŸh³h KRhj¬  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jª  hŸh³h KRhjo  hžhubhé)”}”(hŒGThe encoding type is looked up by number using the following function::”h]”hŒFThe encoding type is looked up by number using the following function:”…””}”(hj;  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Kfhjo  hžhubj  )”}”(hŒAconst struct krb5_enctype *crypto_krb5_find_enctype(u32 enctype);”h]”hŒAconst struct krb5_enctype *crypto_krb5_find_enctype(u32 enctype);”…””}”hjI  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Khhjo  hžhubeh}”(h]”Œencoding-type”ah ]”h"]”Œencoding type”ah$]”h&]”uh1h´hh¶hžhhŸh³h K<ubhµ)”}”(hhh]”(hº)”}”(hŒKey Derivation”h]”hŒKey Derivation”…””}”(hjb  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj_  hžhhŸh³h Kkubhé)”}”(hŒOnce the application has selected an encryption type, the keys that will be
used to do the actual crypto can be derived from the transport key.”h]”hŒOnce the application has selected an encryption type, the keys that will be
used to do the actual crypto can be derived from the transport key.”…””}”(hjp  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Kmhj_  hžhubhµ)”}”(hhh]”(hº)”}”(hŒPRF+ Calculation”h]”hŒPRF+ Calculation”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj~  hžhhŸh³h Kqubhé)”}”(hŒdTo aid in key derivation, a function to calculate the Kerberos GSSAPI
mechanism's PRF+ is provided::”h]”hŒeTo aid in key derivation, a function to calculate the Kerberos GSSAPI
mechanismâ€™s PRF+ is provided:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h Kshj~  hžhubj  )”}”(hX@  int crypto_krb5_calc_PRFplus(const struct krb5_enctype *krb5,
                             const struct krb5_buffer *K,
                             unsigned int L,
                             const struct krb5_buffer *S,
                             struct krb5_buffer *result,
                             gfp_t gfp);”h]”hX@  int crypto_krb5_calc_PRFplus(const struct krb5_enctype *krb5,
                             const struct krb5_buffer *K,
                             unsigned int L,
                             const struct krb5_buffer *S,
                             struct krb5_buffer *result,
                             gfp_t gfp);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Kvhj~  hžhubhé)”}”(hŒeThis can be used to derive the transport key from a source key plus additional
data to limit its use.”h]”hŒeThis can be used to derive the transport key from a source key plus additional
data to limit its use.”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K}hj~  hžhubeh}”(h]”Œprf-calculation”ah ]”h"]”Œprf+ calculation”ah$]”h&]”uh1h´hj_  hžhhŸh³h Kqubeh}”(h]”Œkey-derivation”ah ]”h"]”Œkey derivation”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kkubhµ)”}”(hhh]”(hº)”}”(hŒCrypto Functions”h]”hŒCrypto Functions”…””}”(hjÌ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÉ  hžhhŸh³h Kubhé)”}”(hX  Once the keys have been derived, crypto can be performed on the data.  The
caller must leave gaps in the buffer for the storage of the confounder (if
needed) and the checksum when preparing a message for transmission.  An enum
and a pair of functions are provided to aid in this::”h]”hX  Once the keys have been derived, crypto can be performed on the data.  The
caller must leave gaps in the buffer for the storage of the confounder (if
needed) and the checksum when preparing a message for transmission.  An enum
and a pair of functions are provided to aid in this:”…””}”(hjÚ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KƒhjÉ  hžhubj  )”}”(hXå  enum krb5_crypto_mode {
        KRB5_CHECKSUM_MODE,
        KRB5_ENCRYPT_MODE,
};

size_t crypto_krb5_how_much_buffer(const struct krb5_enctype *krb5,
                                   enum krb5_crypto_mode mode,
                                   size_t data_size, size_t *_offset);

size_t crypto_krb5_how_much_data(const struct krb5_enctype *krb5,
                                 enum krb5_crypto_mode mode,
                                 size_t *_buffer_size, size_t *_offset);”h]”hXå  enum krb5_crypto_mode {
        KRB5_CHECKSUM_MODE,
        KRB5_ENCRYPT_MODE,
};

size_t crypto_krb5_how_much_buffer(const struct krb5_enctype *krb5,
                                   enum krb5_crypto_mode mode,
                                   size_t data_size, size_t *_offset);

size_t crypto_krb5_how_much_data(const struct krb5_enctype *krb5,
                                 enum krb5_crypto_mode mode,
                                 size_t *_buffer_size, size_t *_offset);”…””}”hjè  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h KˆhjÉ  hžhubhé)”}”(hŒsAll these functions take the encoding type and an indication the mode of crypto
(checksum-only or full encryption).”h]”hŒsAll these functions take the encoding type and an indication the mode of crypto
(checksum-only or full encryption).”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K•hjÉ  hžhubhé)”}”(hX<  The first function returns how big the buffer will need to be to house a given
amount of data; the second function returns how much data will fit in a buffer
of a particular size, and adjusts down the size of the required buffer
accordingly.  In both cases, the offset of the data within the buffer is also
returned.”h]”hX<  The first function returns how big the buffer will need to be to house a given
amount of data; the second function returns how much data will fit in a buffer
of a particular size, and adjusts down the size of the required buffer
accordingly.  In both cases, the offset of the data within the buffer is also
returned.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K˜hjÉ  hžhubhé)”}”(hŒsWhen a message has been received, the location and size of the data with the
message can be determined by calling::”h]”hŒrWhen a message has been received, the location and size of the data with the
message can be determined by calling:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KžhjÉ  hžhubj  )”}”(hŒÅvoid crypto_krb5_where_is_the_data(const struct krb5_enctype *krb5,
                                   enum krb5_crypto_mode mode,
                                   size_t *_offset, size_t *_len);”h]”hŒÅvoid crypto_krb5_where_is_the_data(const struct krb5_enctype *krb5,
                                   enum krb5_crypto_mode mode,
                                   size_t *_offset, size_t *_len);”…””}”hj   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K¡hjÉ  hžhubhé)”}”(hŒçThe caller provides the offset and length of the message to the function, which
then alters those values to indicate the region containing the data (plus any
padding).  It is up to the caller to determine how much padding there is.”h]”hŒçThe caller provides the offset and length of the message to the function, which
then alters those values to indicate the region containing the data (plus any
padding).  It is up to the caller to determine how much padding there is.”…””}”(hj.  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K¥hjÉ  hžhubhµ)”}”(hhh]”(hº)”}”(hŒPreparation Functions”h]”hŒPreparation Functions”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj<  hžhhŸh³h Kªubhé)”}”(hŒeTwo functions are provided to allocated and prepare a crypto object for use by
the action functions::”h]”hŒdTwo functions are provided to allocated and prepare a crypto object for use by
the action functions:”…””}”(hjM  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K¬hj<  hžhubj  )”}”(hXŠ  struct crypto_aead *
crypto_krb5_prepare_encryption(const struct krb5_enctype *krb5,
                               const struct krb5_buffer *TK,
                               u32 usage, gfp_t gfp);
struct crypto_shash *
crypto_krb5_prepare_checksum(const struct krb5_enctype *krb5,
                             const struct krb5_buffer *TK,
                             u32 usage, gfp_t gfp);”h]”hXŠ  struct crypto_aead *
crypto_krb5_prepare_encryption(const struct krb5_enctype *krb5,
                               const struct krb5_buffer *TK,
                               u32 usage, gfp_t gfp);
struct crypto_shash *
crypto_krb5_prepare_checksum(const struct krb5_enctype *krb5,
                             const struct krb5_buffer *TK,
                             u32 usage, gfp_t gfp);”…””}”hj[  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K¯hj<  hžhubhé)”}”(hXg  Both of these functions take the encoding type, the transport key and the usage
value used to derive the appropriate subkey(s).  They create an appropriate
crypto object, an AEAD template for encryption and a synchronous hash for
checksumming, set the key(s) on it and configure it.  The caller is expected to
pass these handles to the action functions below.”h]”hXg  Both of these functions take the encoding type, the transport key and the usage
value used to derive the appropriate subkey(s).  They create an appropriate
crypto object, an AEAD template for encryption and a synchronous hash for
checksumming, set the key(s) on it and configure it.  The caller is expected to
pass these handles to the action functions below.”…””}”(hji  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h K¸hj<  hžhubeh}”(h]”Œpreparation-functions”ah ]”h"]”Œpreparation functions”ah$]”h&]”uh1h´hjÉ  hžhhŸh³h Kªubhµ)”}”(hhh]”(hº)”}”(hŒEncryption Mode”h]”hŒEncryption Mode”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h K¿ubhé)”}”(hŒCA pair of functions are provided to encrypt and decrypt a message::”h]”hŒBA pair of functions are provided to encrypt and decrypt a message:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KÁhj  hžhubj  )”}”(hX>  ssize_t crypto_krb5_encrypt(const struct krb5_enctype *krb5,
                            struct crypto_aead *aead,
                            struct scatterlist *sg, unsigned int nr_sg,
                            size_t sg_len,
                            size_t data_offset, size_t data_len,
                            bool preconfounded);
int crypto_krb5_decrypt(const struct krb5_enctype *krb5,
                        struct crypto_aead *aead,
                        struct scatterlist *sg, unsigned int nr_sg,
                        size_t *_offset, size_t *_len);”h]”hX>  ssize_t crypto_krb5_encrypt(const struct krb5_enctype *krb5,
                            struct crypto_aead *aead,
                            struct scatterlist *sg, unsigned int nr_sg,
                            size_t sg_len,
                            size_t data_offset, size_t data_len,
                            bool preconfounded);
int crypto_krb5_decrypt(const struct krb5_enctype *krb5,
                        struct crypto_aead *aead,
                        struct scatterlist *sg, unsigned int nr_sg,
                        size_t *_offset, size_t *_len);”…””}”hjž  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h KÃhj  hžhubhé)”}”(hŒRIn both cases, the input and output buffers are indicated by the same
scatterlist.”h]”hŒRIn both cases, the input and output buffers are indicated by the same
scatterlist.”…””}”(hj¬  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KÎhj  hžhubhé)”}”(hX  For the encryption function, the output buffer may be larger than is needed
(the amount of output generated is returned) and the location and size of the
data are indicated (which must match the encoding).  If no confounder is set,
the function will insert one.”h]”hX  For the encryption function, the output buffer may be larger than is needed
(the amount of output generated is returned) and the location and size of the
data are indicated (which must match the encoding).  If no confounder is set,
the function will insert one.”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KÑhj  hžhubhé)”}”(hŒëFor the decryption function, the offset and length of the message in buffer are
supplied and these are shrunk to fit the data.  The decryption function will
verify any checksums within the message and give an error if they don't match.”h]”hŒíFor the decryption function, the offset and length of the message in buffer are
supplied and these are shrunk to fit the data.  The decryption function will
verify any checksums within the message and give an error if they donâ€™t match.”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KÖhj  hžhubeh}”(h]”Œencryption-mode”ah ]”h"]”Œencryption mode”ah$]”h&]”uh1h´hjÉ  hžhhŸh³h K¿ubhµ)”}”(hhh]”(hº)”}”(hŒChecksum Mode”h]”hŒChecksum Mode”…””}”(hjá  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÞ  hžhhŸh³h KÛubhé)”}”(hŒcA pair of function are provided to generate the checksum on a message and to
verify that checksum::”h]”hŒbA pair of function are provided to generate the checksum on a message and to
verify that checksum:”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KÝhjÞ  hžhubj  )”}”(hX  ssize_t crypto_krb5_get_mic(const struct krb5_enctype *krb5,
                            struct crypto_shash *shash,
                            const struct krb5_buffer *metadata,
                            struct scatterlist *sg, unsigned int nr_sg,
                            size_t sg_len,
                            size_t data_offset, size_t data_len);
int crypto_krb5_verify_mic(const struct krb5_enctype *krb5,
                           struct crypto_shash *shash,
                           const struct krb5_buffer *metadata,
                           struct scatterlist *sg, unsigned int nr_sg,
                           size_t *_offset, size_t *_len);”h]”hX  ssize_t crypto_krb5_get_mic(const struct krb5_enctype *krb5,
                            struct crypto_shash *shash,
                            const struct krb5_buffer *metadata,
                            struct scatterlist *sg, unsigned int nr_sg,
                            size_t sg_len,
                            size_t data_offset, size_t data_len);
int crypto_krb5_verify_mic(const struct krb5_enctype *krb5,
                           struct crypto_shash *shash,
                           const struct krb5_buffer *metadata,
                           struct scatterlist *sg, unsigned int nr_sg,
                           size_t *_offset, size_t *_len);”…””}”hjý  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h KàhjÞ  hžhubhé)”}”(hŒªIn both cases, the input and output buffers are indicated by the same
scatterlist.  Additional metadata can be passed in which will get added to the
hash before the data.”h]”hŒªIn both cases, the input and output buffers are indicated by the same
scatterlist.  Additional metadata can be passed in which will get added to the
hash before the data.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KìhjÞ  hžhubhé)”}”(hŒÊFor the get_mic function, the output buffer may be larger than is needed (the
amount of output generated is returned) and the location and size of the data
are indicated (which must match the encoding).”h]”hŒÊFor the get_mic function, the output buffer may be larger than is needed (the
amount of output generated is returned) and the location and size of the data
are indicated (which must match the encoding).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KðhjÞ  hžhubhé)”}”(hŒ¹For the verification function, the offset and length of the message in buffer
are supplied and these are shrunk to fit the data.  An error will be returned
if the checksums don't match.”h]”hŒ»For the verification function, the offset and length of the message in buffer
are supplied and these are shrunk to fit the data.  An error will be returned
if the checksums donâ€™t match.”…””}”(hj'  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KôhjÞ  hžhubeh}”(h]”Œchecksum-mode”ah ]”h"]”Œchecksum mode”ah$]”h&]”uh1h´hjÉ  hžhhŸh³h KÛubeh}”(h]”Œcrypto-functions”ah ]”h"]”Œcrypto functions”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒThe krb5enc AEAD algorithm”h]”hŒThe krb5enc AEAD algorithm”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjE  hžhhŸh³h Kùubhé)”}”(hX,  A template AEAD crypto algorithm, called "krb5enc", is provided that hashes the
plaintext before encrypting it (the reverse of authenc).  The handle returned
by ``crypto_krb5_prepare_encryption()`` may be one of these, but there's no
requirement for the user of this API to interact with it directly.”h]”(hŒ¥A template AEAD crypto algorithm, called â€œkrb5encâ€, is provided that hashes the
plaintext before encrypting it (the reverse of authenc).  The handle returned
by ”…””}”(hjV  hžhhŸNh NubjÀ  )”}”(hŒ$``crypto_krb5_prepare_encryption()``”h]”hŒ crypto_krb5_prepare_encryption()”…””}”(hj^  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¿  hjV  ubhŒi may be one of these, but thereâ€™s no
requirement for the user of this API to interact with it directly.”…””}”(hjV  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h KûhjE  hžhubhé)”}”(hŒùFor reference, its key format begins with a BE32 of the format number.  Only
format 1 is provided and that continues with a BE32 of the Ke key length
followed by a BE32 of the Ki key length, followed by the bytes from the Ke key
and then the Ki key.”h]”hŒùFor reference, its key format begins with a BE32 of the format number.  Only
format 1 is provided and that continues with a BE32 of the Ke key length
followed by a BE32 of the Ki key length, followed by the bytes from the Ke key
and then the Ki key.”…””}”(hjv  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h M hjE  hžhubhé)”}”(hŒ^Using specifically ordered words means that the static test data doesn't
require byteswapping.”h]”hŒ`Using specifically ordered words means that the static test data doesnâ€™t
require byteswapping.”…””}”(hj„  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hèhŸh³h MhjE  hžhubeh}”(h]”Œthe-krb5enc-aead-algorithm”ah ]”h"]”Œthe krb5enc aead algorithm”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kùubeh}”(h]”Œkerberos-v-cryptography-api”ah ]”h"]”Œkerberos v cryptography api”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jÅ  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jŸ  jœ  jl  ji  jd  ja  j\  jY  jÆ  jÃ  j¾  j»  jB  j?  j|  jy  jÛ  jØ  j:  j7  j—  j”  uŒ	nametypes”}”(jŸ  ‰jl  ‰jd  ‰j\  ‰jÆ  ‰j¾  ‰jB  ‰j|  ‰jÛ  ‰j:  ‰j—  ‰uh}”(jœ  h¶ji  h×ja  j2  jY  jo  jÃ  j_  j»  j~  j?  jÉ  jy  j<  jØ  j  j7  jÞ  j”  jE  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.