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

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "ENGINE 1"
 132 .TH ENGINE 1 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-engine, engine \- load and query engines
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl engine\fR
 142 [ \fIengine...\fR ]
 143 [\fB\-v\fR]
 144 [\fB\-vv\fR]
 145 [\fB\-vvv\fR]
 146 [\fB\-vvv\fR]
 147 [\fB\-vvv\fR]
 148 [\fB\-c\fR]
 149 [\fB\-t\fR]
 150 [\fB\-tt\fR]
 151 [\fB\-pre\fR \fIcommand\fR]
 152 [\fB\-post\fR \fIcommand\fR]
 153 [ \fIengine...\fR ]
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 The \fBengine\fR command is used to query the status and capabilities
 157 of the specified \fBengine\fR's.
 158 Engines may be specified before and after all other command-line flags.
 159 Only those specified are queried.
 160 .SH "OPTIONS"
 161 .IX Header "OPTIONS"
 162 .IP "\fB\-v\fR \fB\-vv\fR \fB\-vvv\fR \fB\-vvvv\fR" 4
 163 .IX Item "-v -vv -vvv -vvvv"
 164 Provides information about each specified engine. The first flag lists
 165 all the possible run-time control commands; the second adds a
 166 description of each command; the third adds the input flags, and the
 167 final option adds the internal input flags.
 168 .IP "\fB\-c\fR" 4
 169 .IX Item "-c"
 170 Lists the capabilities of each engine.
 171 .IP "\fB\-t\fR" 4
 172 .IX Item "-t"
 173 Tests if each specified engine is available, and displays the answer.
 174 .IP "\fB\-tt\fR" 4
 175 .IX Item "-tt"
 176 Displays an error trace for any unavailable engine.
 177 .IP "\fB\-pre\fR \fIcommand\fR" 4
 178 .IX Item "-pre command"
 179 .PD 0
 180 .IP "\fB\-post\fR \fIcommand\fR" 4
 181 .IX Item "-post command"
 182 .PD
 183 Command-line configuration of engines.
 184 The \fB\-pre\fR command is given to the engine before it is loaded and
 185 the \fB\-post\fR command is given after the engine is loaded.
 186 The \fIcommand\fR is of the form \fIcmd:val\fR where \fIcmd\fR is the command,
 187 and \fIval\fR is the value for the command.
 188 See the example below.
 189 .SH "EXAMPLE"
 190 .IX Header "EXAMPLE"
 191 To list all the commands available to a dynamic engine:
 192 .PP
 193 .Vb 10
 194 \& $ openssl engine \-t \-tt \-vvvv dynamic
 195 \& (dynamic) Dynamic engine loading support
 196 \&      [ unavailable ]
 197 \&      SO_PATH: Specifies the path to the new ENGINE shared library
 198 \&           (input flags): STRING
 199 \&      NO_VCHECK: Specifies to continue even if version checking fails (boolean)
 200 \&           (input flags): NUMERIC
 201 \&      ID: Specifies an ENGINE id name for loading
 202 \&           (input flags): STRING
 203 \&      LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
 204 \&           (input flags): NUMERIC
 205 \&      DIR_LOAD: Specifies whether to load from \*(AqDIR_ADD\*(Aq directories (0=no,1=yes,2=mandatory)
 206 \&           (input flags): NUMERIC
 207 \&      DIR_ADD: Adds a directory from which ENGINEs can be loaded
 208 \&           (input flags): STRING
 209 \&      LOAD: Load up the ENGINE specified by other settings
 210 \&           (input flags): NO_INPUT
 211 .Ve
 212 .PP
 213 To list the capabilities of the \fIrsax\fR engine:
 214 .PP
 215 .Vb 4
 216 \& $ openssl engine \-c
 217 \& (rsax) RSAX engine support
 218 \&  [RSA]
 219 \& (dynamic) Dynamic engine loading support
 220 .Ve
 221 .SH "ENVIRONMENT"
 222 .IX Header "ENVIRONMENT"
 223 .IP "\fB\s-1OPENSSL_ENGINES\s0\fR" 4
 224 .IX Item "OPENSSL_ENGINES"
 225 The path to the engines directory.
 226 .SH "SEE ALSO"
 227 .IX Header "SEE ALSO"
 228 \&\fIconfig\fR\|(5)
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.