Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
freebsd
GitHub Repository: freebsd/freebsd-src
Path: blob/main/secure/usr.bin/openssl/man/openssl-skeyutl.1
107607 views
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "OPENSSL-SKEYUTL 1ossl"
.TH OPENSSL-SKEYUTL 1ossl 2026-01-27 3.5.5 OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
openssl\-skeyutl \- opaque symmetric keys routines
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBopenssl\fR \fBskeyutl\fR
[\fB\-help\fR]
[\fB\-cipher\fR \fIcipher\fR]
[\fB\-skeymgmt\fR \fIskeymgmt\fR]
[\fB\-skeyopt\fR \fIopt\fR:\fIvalue\fR]
[\fB\-genkey\fR]
[\fB\-provider\fR \fIname\fR]
[\fB\-provider\-path\fR \fIpath\fR]
[\fB\-provparam\fR \fI[name:]key=value\fR]
[\fB\-propquery\fR \fIpropq\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Not all cipher implementations support keys as raw bytes. E.g. PKCS#11 tokens
can store them internally without any option to get the raw byte representation.
.PP
This tool is designed for managing opaque symmetric keys.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-help\fR 4
.IX Item "-help"
Print out a usage message.
.IP "\fB\-cipher\fR \fIcipher\fR" 4
.IX Item "-cipher cipher"
The cipher to generate the key for.
.IP "\fB\-skeymgmt\fR \fIskeymgmt\fR" 4
.IX Item "-skeymgmt skeymgmt"
Some providers may support opaque symmetric keys objects. To use them, we need
to know the \fIskeymgmt\fR. If not specified, the name of the cipher will be used.
.Sp
To find out the name of the suitable symmetric key management,
please refer to the output of the \f(CW\*(C`openssl list \-skey\-managers\*(C'\fR command.
.IP "\fB\-skeyopt\fR \fIopt\fR:\fIvalue\fR" 4
.IX Item "-skeyopt opt:value"
To obtain an existing opaque symmetric key or to generate a new one, key
options are specified as opt:value. These options can\*(Aqt be used together with
any options implying raw key either directly or indirectly.
.IP \fB\-genkey\fR 4
.IX Item "-genkey"
Generate a new opaque key object.
.IP "\fB\-provider\fR \fIname\fR" 4
.IX Item "-provider name"
.PD 0
.IP "\fB\-provider\-path\fR \fIpath\fR" 4
.IX Item "-provider-path path"
.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
.IX Item "-provparam [name:]key=value"
.IP "\fB\-propquery\fR \fIpropq\fR" 4
.IX Item "-propquery propq"
.PD
See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBopenssl\-enc\fR\|(1), \fBEVP_SKEY\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
The \fBskeyutl\fR command was added in OpenSSL 3.5.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.
.PP
Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.