secure/usr.bin/openssl/man/engine.1

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "ENGINE 1"
 136 .TH ENGINE 1 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 openssl\-engine, engine \- load and query engines
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl engine\fR
 146 [ \fIengine...\fR ]
 147 [\fB\-v\fR]
 148 [\fB\-vv\fR]
 149 [\fB\-vvv\fR]
 150 [\fB\-vvv\fR]
 151 [\fB\-vvv\fR]
 152 [\fB\-c\fR]
 153 [\fB\-t\fR]
 154 [\fB\-tt\fR]
 155 [\fB\-pre\fR \fIcommand\fR]
 156 [\fB\-post\fR \fIcommand\fR]
 157 [ \fIengine...\fR ]
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 The \fBengine\fR command is used to query the status and capabilities
 161 of the specified \fBengine\fR's.
 162 Engines may be specified before and after all other command-line flags.
 163 Only those specified are queried.
 164 .SH "OPTIONS"
 165 .IX Header "OPTIONS"
 166 .IP "\fB\-v\fR \fB\-vv\fR \fB\-vvv\fR \fB\-vvvv\fR" 4
 167 .IX Item "-v -vv -vvv -vvvv"
 168 Provides information about each specified engine. The first flag lists
 169 all the possible run-time control commands; the second adds a
 170 description of each command; the third adds the input flags, and the
 171 final option adds the internal input flags.
 172 .IP "\fB\-c\fR" 4
 173 .IX Item "-c"
 174 Lists the capabilities of each engine.
 175 .IP "\fB\-t\fR" 4
 176 .IX Item "-t"
 177 Tests if each specified engine is available, and displays the answer.
 178 .IP "\fB\-tt\fR" 4
 179 .IX Item "-tt"
 180 Displays an error trace for any unavailable engine.
 181 .IP "\fB\-pre\fR \fIcommand\fR" 4
 182 .IX Item "-pre command"
 183 .PD 0
 184 .IP "\fB\-post\fR \fIcommand\fR" 4
 185 .IX Item "-post command"
 186 .PD
 187 Command-line configuration of engines.
 188 The \fB\-pre\fR command is given to the engine before it is loaded and
 189 the \fB\-post\fR command is given after the engine is loaded.
 190 The \fIcommand\fR is of the form \fIcmd:val\fR where \fIcmd\fR is the command,
 191 and \fIval\fR is the value for the command.
 192 See the example below.
 193 .SH "EXAMPLES"
 194 .IX Header "EXAMPLES"
 195 To list all the commands available to a dynamic engine:
 196 .PP
 197 .Vb 10
 198 \& $ openssl engine \-t \-tt \-vvvv dynamic
 199 \& (dynamic) Dynamic engine loading support
 200 \&      [ unavailable ]
 201 \&      SO_PATH: Specifies the path to the new ENGINE shared library
 202 \&           (input flags): STRING
 203 \&      NO_VCHECK: Specifies to continue even if version checking fails (boolean)
 204 \&           (input flags): NUMERIC
 205 \&      ID: Specifies an ENGINE id name for loading
 206 \&           (input flags): STRING
 207 \&      LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
 208 \&           (input flags): NUMERIC
 209 \&      DIR_LOAD: Specifies whether to load from \*(AqDIR_ADD\*(Aq directories (0=no,1=yes,2=mandatory)
 210 \&           (input flags): NUMERIC
 211 \&      DIR_ADD: Adds a directory from which ENGINEs can be loaded
 212 \&           (input flags): STRING
 213 \&      LOAD: Load up the ENGINE specified by other settings
 214 \&           (input flags): NO_INPUT
 215 .Ve
 216 .PP
 217 To list the capabilities of the \fIrsax\fR engine:
 218 .PP
 219 .Vb 4
 220 \& $ openssl engine \-c
 221 \& (rsax) RSAX engine support
 222 \&  [RSA]
 223 \& (dynamic) Dynamic engine loading support
 224 .Ve
 225 .SH "ENVIRONMENT"
 226 .IX Header "ENVIRONMENT"
 227 .IP "\fB\s-1OPENSSL_ENGINES\s0\fR" 4
 228 .IX Item "OPENSSL_ENGINES"
 229 The path to the engines directory.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\fBconfig\fR\|(5)
 233 .SH "COPYRIGHT"
 234 .IX Header "COPYRIGHT"
 235 Copyright 2016\-2019 The OpenSSL Project Authors. All Rights Reserved.
 236 .PP
 237 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 238 this file except in compliance with the License.  You can obtain a copy
 239 in the file \s-1LICENSE\s0 in the source distribution or at
 240 <https://www.openssl.org/source/license.html>.