oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

document krb5_enctype_to_string and krb5_string_to_enctype

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@12176 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2003-04-29 09:59:27 +00:00
parent d7267be347
commit a467a79d2e
1 changed files with 27 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
lib/krb5/krb5_crypto_init.3
View File

@@ -35,9 +35,11 @@
.Dt NAME 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_crypto_init ,
.Nm krb5_crypto_destroy
.Nd initialize encryption context
.NM krb5_enctype_to_string ,
.NM krb5_string_to_enctype ,
.Nm krb5_crypto_destroy ,
.Nm krb5_crypto_init
.Nd encryption support in krb5
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
@@ -46,23 +48,33 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fn krb5_crypto_init "krb5_context context" "krb5_keyblock *key" "krb5_enctype enctype" "krb5_crypto *crypto"
.Ft krb5_error_code
.Fn krb5_crypto_destroy "krb5_context context" "krb5_crypto crypto"
.Ft krb5_error_code
.Fn krb5_string_to_enctype "krb5_context context" "const char *string" "krb5_enctype *etype"
.Ft krb5_error_code
.Fn krb5_enctype_to_string "krb5_context context" "krb5_enctype etype" "char **string"
.Sh DESCRIPTION
These functions are used to initialize an encryption context that can
be used to encrypt or checksum data.
Heimdal exports parts of the Kerberos crypto interface for applications.
.Pp
The
.Fn krb5_crypt_init
initializes the encrytion context
.Fa crypto .
The
.Fa key
parameter is the key to use for encryption, and checksums. The
encryption type to use is taken from the key, but can be overridden
Each kerberos encrytion/checksum function takes a crypto context.
.Pp
To setup and destroy crypto contextes there are two functions
.Fn krb5_crypto_init
and
.Fn krb5_crypto_destroy .
The encryption type to use is taken from the key, but can be overridden
with the
.Fa enctype parameter .
This can be useful for encryptions types which is compatiable (DES for
example).
.Pp
.Fn krb5_crypto_destroy
frees a previously allocated encrypion context.
.Fn krb5_enctype_to_string
converts a encryption type number to a string that can be printable
and stored. The strings returned should be freed with
.Xr free 3 .
.Pp
.Fn krb5_string_to_enctype
converts a encryption type strings to a encryption type number that
can use used for other Kerberos crypto functions.
.\" .Sh EXAMPLE
.\" .Sh BUGS
.Sh SEE ALSO