xref: /freebsd/crypto/heimdal/lib/krb5/krb5_encrypt.3 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
1.\" Copyright (c) 1999 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_encrypt.3,v 1.5 2002/08/28 15:30:50 joda Exp $
3.Dd April  7, 1999
4.Dt KRB5_ENCRYPT 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_decrypt ,
8.Nm krb5_decrypt_EncryptedData ,
9.Nm krb5_encrypt ,
10.Nm krb5_encrypt_EncryptedData
11.Nd encrypt and decrypt data
12.Sh LIBRARY
13Kerberos 5 Library (libkrb5, -lkrb5)
14.Sh SYNOPSIS
15.Fd #include <krb5.h>
16.Ft krb5_error_code
17.Fn krb5_encrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
18.Ft krb5_error_code
19.Fn krb5_encrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "int kvno" "EncryptedData *result"
20.Ft krb5_error_code
21.Fn krb5_decrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
22.Ft krb5_error_code
23.Fn krb5_decrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "EncryptedData *e" "krb5_data *result"
24.Sh DESCRIPTION
25These functions are used to encrypt and decrypt data.
26.Pp
27.Fn krb5_encrypt
28puts the encrypted version of
29.Fa data
30(of size
31.Fa len )
32in
33.Fa result .
34If the encryption type supports using derived keys,
35.Fa usage
36should be the appropriate key-usage.
37.Fn krb5_encrypt_EncryptedData
38does the same as
39.Fn krb5_encrypt ,
40but it puts the encrypted data in a
41.Fa EncryptedData
42structure instead. If
43.Fa kvno
44is not zero, it will be put in the
45.Fa kvno field in the
46.Fa EncryptedData .
47.Pp
48.Fn krb5_decrypt ,
49and
50.Fn krb5_decrypt_EncryptedData
51works similarly.
52.\" .Sh EXAMPLE
53.\" .Sh BUGS
54.Sh SEE ALSO
55.Xr krb5_create_checksum 3 ,
56.Xr krb5_crypto_init 3
57