heimdal/lib/krb5/krb5_encrypt.3

.\" Copyright (c) 1999 - 2003 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id$
.\"
.Dd March 20, 2004
.Dt KRB5_ENCRYPT 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_crypto_getblocksize ,
.Nm krb5_crypto_getconfoundersize
.Nm krb5_crypto_getenctype ,
.Nm krb5_crypto_getpadsize ,
.Nm krb5_decrypt ,
.Nm krb5_decrypt_EncryptedData ,
.Nm krb5_encrypt ,
.Nm krb5_encrypt_EncryptedData,
.Nm krb5_enctype_disable ,
.Nm krb5_enctype_is_disabled ,
.Nm krb5_enctype_keysize ,
.Nm krb5_enctype_to_string ,
.Nm krb5_string_to_enctype ,
.Nd encrypt and decrypt data, set and get encryption type parameters
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Ft krb5_error_code
.Fn krb5_encrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
.Ft krb5_error_code
.Fn krb5_encrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "int kvno" "EncryptedData *result"
.Ft krb5_error_code
.Fn krb5_decrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
.Ft krb5_error_code
.Fn krb5_decrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "EncryptedData *e" "krb5_data *result"
.Ft krb5_error_code
.Fo krb5_crypto_getblocksize
.Fa "krb5_context context"
.Fa "size_t *blocksize"
.Fc
.Ft krb5_error_code
.Fo krb5_crypto_getenctype
.Fa "krb5_context context"
.Fa "krb5_crypto crypto"
.Fa "krb5_enctype *enctype"
.Fc
.Ft krb5_error_code
.Fo krb5_crypto_getpadsize
.Fa "krb5_context context"
.Fa size_t *padsize"
.Fc
.Ft krb5_error_code
.Fo krb5_crypto_getconfoundersize
.Fa "krb5_context context"
.Fa "krb5_crypto crypto
.Fa size_t *confoundersize"
.Fc
.Ft krb5_error_code
.Fo krb5_enctype_keysize
.Fa "krb5_context context"
.Fa "krb5_enctype type"
.Fa "size_t *keysize"
.Fc
.Ft krb5_error_code
.Fo krb5_string_to_enctype
.Fa "krb5_context context"
.Fa "const char *string"
.Fa "krb5_enctype *etype"
.Fc
.Ft krb5_error_code
.Fo krb5_enctype_to_string
.Fa "krb5_context context"
.Fa "krb5_enctype etype"
.Fa "char **string"
.Fc
.Ft krb5_boolean
.Fo krb5_enctype_is_disabled
.Fa "krb5_context context"
.Fa "krb5_enctype etype"
.Fc
.Ft void
.Fo krb5_enctype_disable
.Fa "krb5_context context"
.Fa "krb5_enctype etype"
.Fc
.Sh DESCRIPTION
These functions are used to encrypt and decrypt data.
.Pp
.Fn krb5_encrypt
puts the encrypted version of
.Fa data
(of size
.Fa len )
in
.Fa result .
If the encryption type supports using derived keys,
.Fa usage
should be the appropriate key-usage.
.Fn krb5_encrypt_EncryptedData
does the same as
.Fn krb5_encrypt ,
but it puts the encrypted data in a
.Fa EncryptedData
structure instead. If
.Fa kvno
is not zero, it will be put in the
.Fa kvno field in the
.Fa EncryptedData .
.Pp
.Fn krb5_decrypt ,
and
.Fn krb5_decrypt_EncryptedData
works similarly.
.Pp
.Fn krb5_enctype_keysize ,
.Fn krb5_crypto_getconfoundersize ,
.Fn krb5_crypto_getblocksize ,
.Fn krb5_crypto_getenctype ,
.Fn krb5_crypto_getpadsize
all returns various (sometimes) useful information from a crypto context.
.Pp
.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.
.Pp
.Fn krb5_enctype_is_disabled
return non-zero if
.Fa enctype
is (globally) disabled (and thus can't be used for
encryption/decryption).
.Pp
.Fn krb5_enctype_disable
(globally, for all contextes) disables the
.Fa enctype .
.\" .Sh EXAMPLE
.\" .Sh BUGS
.Sh SEE ALSO
.Xr krb5_create_checksum 3 ,
.Xr krb5_crypto_init 3