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
61
62
|
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
.TH "shishi_encrypt" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shishi_encrypt \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "int shishi_encrypt(Shishi * " handle ", Shishi_key * " key ", int " keyusage ", char * " in ", size_t " inlen ", char ** " out ", size_t * " outlen ");"
.SH ARGUMENTS
.IP "Shishi * handle" 12
shishi handle as allocated by \fBshishi_init()\fP.
.IP "Shishi_key * key" 12
key to encrypt with.
.IP "int keyusage" 12
integer specifying what this key is encrypting.
.IP "char * in" 12
input array with data to encrypt.
.IP "size_t inlen" 12
size of input array with data to encrypt.
.IP "char ** out" 12
output array with newly allocated encrypted data.
.IP "size_t * outlen" 12
output variable with size of newly allocated output array.
.SH "DESCRIPTION"
Encrypts data using specified key. The key actually used is
derived using the key usage. If key usage is 0, no key derivation
is used. The OUT buffer must be deallocated by the caller. The
default IV is used, see shishi_encrypt_iv if you need to alter it.
The next IV is lost, see shishi_encrypt_ivupdate if you need it.
Note that DECRYPT(ENCRYPT(data)) does not necessarily yield data
exactly. Some encryption types add pad to make the data fit into
the block size of the encryption algorithm. Furthermore, the pad
is not guaranteed to look in any special way, although existing
implementations often pad with the zero byte. This means that you
may have to "frame" data, so it is possible to infer the original
length after decryption. Compare ASN.1 DER which contains such
information.
.SH "RETURN VALUE"
Returns \fBSHISHI_OK\fP iff successful.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
GNU Shishi home page: http://www.gnu.org/software/shishi/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2002-2022 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B shishi
is maintained as a Texinfo manual. If the
.B info
and
.B shishi
programs are properly installed at your site, the command
.IP
.B info shishi
.PP
should give you access to the complete manual.
|
