Debian Codegraph @

upstream/debian-unstable/man1/openssl-skeyutl.1ssl

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 "OPENSSL-SKEYUTL 1SSL"
58 .TH OPENSSL-SKEYUTL 1SSL 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 openssl\-skeyutl \- opaque symmetric keys routines
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl\fR \fBskeyutl\fR
68 [\fB\-help\fR]
69 [\fB\-cipher\fR \fIcipher\fR]
70 [\fB\-skeymgmt\fR \fIskeymgmt\fR]
71 [\fB\-skeyopt\fR \fIopt\fR:\fIvalue\fR]
72 [\fB\-genkey\fR]
73 [\fB\-provider\fR \fIname\fR]
74 [\fB\-provider\-path\fR \fIpath\fR]
75 [\fB\-provparam\fR \fI[name:]key=value\fR]
76 [\fB\-propquery\fR \fIpropq\fR]
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 Not all cipher implementations support keys as raw bytes. E.g. PKCS#11 tokens
80 can store them internally without any option to get the raw byte representation.
81 .PP
82 This tool is designed for managing opaque symmetric keys.
83 .SH OPTIONS
84 .IX Header "OPTIONS"
85 .IP \fB\-help\fR 4
86 .IX Item "-help"
87 Print out a usage message.
88 .IP "\fB\-cipher\fR \fIcipher\fR" 4
89 .IX Item "-cipher cipher"
90 The cipher to generate the key for.
91 .IP "\fB\-skeymgmt\fR \fIskeymgmt\fR" 4
92 .IX Item "-skeymgmt skeymgmt"
93 Some providers may support opaque symmetric keys objects. To use them, we need
94 to know the \fIskeymgmt\fR. If not specified, the name of the cipher will be used.
95 .Sp
96 To find out the name of the suitable symmetric key management,
97 please refer to the output of the \f(CW\*(C`openssl list \-skey\-managers\*(C'\fR command.
98 .IP "\fB\-skeyopt\fR \fIopt\fR:\fIvalue\fR" 4
99 .IX Item "-skeyopt opt:value"
100 To obtain an existing opaque symmetric key or to generate a new one, key
101 options are specified as opt:value. These options can't be used together with
102 any options implying raw key either directly or indirectly.
103 .IP \fB\-genkey\fR 4
104 .IX Item "-genkey"
105 Generate a new opaque key object.
106 .IP "\fB\-provider\fR \fIname\fR" 4
107 .IX Item "-provider name"
108 .PD 0
109 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
110 .IX Item "-provider-path path"
111 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
112 .IX Item "-provparam [name:]key=value"
113 .IP "\fB\-propquery\fR \fIpropq\fR" 4
114 .IX Item "-propquery propq"
115 .PD
116 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBopenssl\-enc\fR\|(1), \fBEVP_SKEY\fR\|(3)
120 .SH HISTORY
121 .IX Header "HISTORY"
122 The \fBskeyutl\fR command was added in OpenSSL 3.5.
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.
126 .PP
127 Licensed under the Apache License 2.0 (the "License"). You may not use
128 this file except in compliance with the License. You can obtain a copy
129 in the file LICENSE in the source distribution or at
130 <https://www.openssl.org/source/license.html>.