xref: /freebsd/crypto/heimdal/lib/krb5/krb5_encrypt.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\" Copyright (c) 1999 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_encrypt.3,v 1.1 1999/04/18 13:47:30 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 SYNOPSIS
13.Fd #include <krb5.h>
14
15.Ft krb5_error_code
16.Fn krb5_encrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
17
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
21.Ft krb5_error_code
22.Fn krb5_decrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result"
23
24.Ft krb5_error_code
25.Fn krb5_decrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "EncryptedData *e" "krb5_data *result"
26
27.Sh DESCRIPTION
28These functions are used to encrypt and decrypt data.
29.Pp
30.Fn krb5_encrypt
31puts the encrypted version of
32.Fa data
33(of size
34.Fa len )
35in
36.Fa result .
37If the encryption type supports using derived keys,
38.Fa usage
39should be the appropriate key-usage.
40.Fn krb5_encrypt_EncryptedData
41does the same as
42.Fn krb5_encrypt ,
43but it puts the encrypted data in a
44.Fa EncryptedData
45structure instead. If
46.Fa kvno
47is not zero, it will be put in the
48.Fa kvno field in the
49.Fa EncryptedData .
50.Pp
51.Fn krb5_decrypt ,
52and
53.Fn krb5_decrypt_EncryptedData
54works similarly.
55
56.\" .Sh EXAMPLE
57.\" .Sh BUGS
58.Sh SEE ALSO
59.Xr krb5_crypto_init 3 ,
60.Xr krb5_create_checksum 3
61