xref: /freebsd/crypto/openssl/doc/man7/EVP_CIPHER-NULL.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryEVP_CIPHER-NULL - The NULL EVP_CIPHER implementation
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 DESCRIPTION
8*b077aed3SPierre Pronchery
9*b077aed3SPierre ProncherySupport for a NULL symmetric encryption using the B<EVP_CIPHER> API.
10*b077aed3SPierre ProncheryThis is used when the TLS cipher suite is TLS_NULL_WITH_NULL_NULL.
11*b077aed3SPierre ProncheryThis does no encryption (just copies the data) and has a mac size of zero.
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=head2 Algorithm Name
14*b077aed3SPierre Pronchery
15*b077aed3SPierre ProncheryThe following algorithm is available in the default provider:
16*b077aed3SPierre Pronchery
17*b077aed3SPierre Pronchery=over 4
18*b077aed3SPierre Pronchery
19*b077aed3SPierre Pronchery=item "NULL"
20*b077aed3SPierre Pronchery
21*b077aed3SPierre Pronchery=back
22*b077aed3SPierre Pronchery
23*b077aed3SPierre Pronchery=head2 Parameters
24*b077aed3SPierre Pronchery
25*b077aed3SPierre ProncheryThis implementation supports the following parameters:
26*b077aed3SPierre Pronchery
27*b077aed3SPierre Pronchery=head3 Gettable EVP_CIPHER parameters
28*b077aed3SPierre Pronchery
29*b077aed3SPierre ProncherySee L<EVP_EncryptInit(3)/Gettable EVP_CIPHER parameters>
30*b077aed3SPierre Pronchery
31*b077aed3SPierre Pronchery=head3 Gettable EVP_CIPHER_CTX parameters
32*b077aed3SPierre Pronchery
33*b077aed3SPierre Pronchery=over 4
34*b077aed3SPierre Pronchery
35*b077aed3SPierre Pronchery=item "keylen" (B<OSSL_CIPHER_PARAM_KEYLEN>) <unsigned integer>
36*b077aed3SPierre Pronchery
37*b077aed3SPierre Pronchery=item "ivlen" (B<OSSL_CIPHER_PARAM_IVLEN> and <B<OSSL_CIPHER_PARAM_AEAD_IVLEN>) <unsigned integer>
38*b077aed3SPierre Pronchery
39*b077aed3SPierre Pronchery=item "tls-mac" (B<OSSL_CIPHER_PARAM_TLS_MAC>) <octet ptr>
40*b077aed3SPierre Pronchery
41*b077aed3SPierre Pronchery=back
42*b077aed3SPierre Pronchery
43*b077aed3SPierre ProncherySee L<EVP_EncryptInit(3)/PARAMETERS> for further information.
44*b077aed3SPierre Pronchery
45*b077aed3SPierre Pronchery=head3 Settable EVP_CIPHER_CTX parameters
46*b077aed3SPierre Pronchery
47*b077aed3SPierre Pronchery=over 4
48*b077aed3SPierre Pronchery
49*b077aed3SPierre Pronchery=item "tls-mac-size" (B<OSSL_CIPHER_PARAM_TLS_MAC_SIZE>) <unsigned integer>
50*b077aed3SPierre Pronchery
51*b077aed3SPierre Pronchery=back
52*b077aed3SPierre Pronchery
53*b077aed3SPierre ProncherySee L<EVP_EncryptInit(3)/PARAMETERS> for further information.
54*b077aed3SPierre Pronchery
55*b077aed3SPierre Pronchery=head1 CONFORMING TO
56*b077aed3SPierre Pronchery
57*b077aed3SPierre ProncheryRFC 5246 section-6.2.3.1
58*b077aed3SPierre Pronchery
59*b077aed3SPierre Pronchery=head1 SEE ALSO
60*b077aed3SPierre Pronchery
61*b077aed3SPierre ProncheryL<provider-cipher(7)>, L<OSSL_PROVIDER-default(7)>
62*b077aed3SPierre Pronchery
63*b077aed3SPierre Pronchery=head1 COPYRIGHT
64*b077aed3SPierre Pronchery
65*b077aed3SPierre ProncheryCopyright 2023 The OpenSSL Project Authors. All Rights Reserved.
66*b077aed3SPierre Pronchery
67*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
68*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
69*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
70*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
71*b077aed3SPierre Pronchery
72*b077aed3SPierre Pronchery=cut
73