summaryrefslogtreecommitdiffstats
path: root/crypto/heimdal/lib/krb5/krb5_encrypt.3
blob: d8cc89eee3d26df503045e8dddac33702721befd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.\" Copyright (c) 1999 Kungliga Tekniska Högskolan
.\" $Id: krb5_encrypt.3,v 1.1 1999/04/18 13:47:30 joda Exp $
.Dd April  7, 1999
.Dt KRB5_ENCRYPT 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_decrypt , 
.Nm krb5_decrypt_EncryptedData , 
.Nm krb5_encrypt , 
.Nm krb5_encrypt_EncryptedData
.Nd encrypt and decrypt data
.Sh SYNOPSIS
.Fd #include <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"

.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.

.\" .Sh EXAMPLE
.\" .Sh BUGS
.Sh SEE ALSO
.Xr krb5_crypto_init 3 ,
.Xr krb5_create_checksum 3
OpenPOWER on IntegriCloud