Debian Codegraph @

upstream/debian-unstable/man7/EVP_SIGNATURE-LMS.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_SIGNATURE-LMS 7SSL"
58 .TH EVP_SIGNATURE-LMS 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_SIGNATURE\-LMS
65 \&\- The EVP_PKEY LMS signature implementation
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 The \fBLMS\fR EVP_PKEY implementation supports Leighton-Micali Signatures (LMS)
69 described in [RFC 8554](https://datatracker.ietf.org/doc/html/rfc8854)
70 and [SP 800\-208](https://csrc.nist.gov/pubs/sp/800/208/final).
71 The OpenSSL providers only support LMS signature verification, as this is a
72 [SP 800\-208](https://csrc.nist.gov/pubs/sp/800/208/final) requirement for
73 FIPS software modules.
74 .PP
75 \&\fBEVP_PKEY_verify_message_init()\fR and \fBEVP_PKEY_verify()\fR are the only supported
76 functions used for LMS signatures. Streaming is not currently supported,
77 and since the signature data contains data related to the digest used, functions
78 that specify the digest name are not necessary.
79 .SH NOTES
80 .IX Header "NOTES"
81 LMS support is disabled by default at compile-time.
82 To enable, specify the \fBenable-lms\fR build configuration option.
83 .PP
84 LMS should only be used for older deployments.
85 New deployments should use either \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)
86 or <L/\fBEVP_SIGNATURE\-SLH\-DSA\fR\|(7)>.
87 .SH EXAMPLES
88 .IX Header "EXAMPLES"
89 Error checking has been omitted from the following examples
90 .SS "LMS signature verification"
91 .IX Subsection "LMS signature verification"
92 .Vb 10
93 \& /* See L<EVP_PKEY\-LMS(7)/EXAMPLES for an example of loading a LMS |pub| key */
94 \& ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pub, propq);
95 \& sig = EVP_SIGNATURE_fetch(libctx, "LMS", propq);
96 \& EVP_PKEY_verify_message_init(ctx, sig, NULL);
97 \& /*
98 \& * EVP_PKEY_verify_message_update() and EVP_PKEY_verify_message_final()
99 \& * are not supported
100 \& */
101 \& ret = EVP_PKEY_verify(ctx, sigdata, sigdata_len, msg, msglen);
102 \& /*
103 \& * ret == 1 indicates success, 0 verify failure and < 0 for some
104 \& * other error.
105 \& */
106 .Ve
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBEVP_PKEY\-LMS\fR\|(7),
110 \&\fBprovider\-signature\fR\|(7),
111 .SH HISTORY
112 .IX Header "HISTORY"
113 This functionality was added in OpenSSL 3.6.
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2025\-2026 The OpenSSL Project Authors. All Rights Reserved.
117 .PP
118 Licensed under the Apache License 2.0 (the "License"). You may not use
119 this file except in compliance with the License. You can obtain a copy
120 in the file LICENSE in the source distribution or at
121 <https://www.openssl.org/source/license.html>.