doc/man1/openssl-engine.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-engine - load and query engines
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl engine>
  10 [B<-help>]
  11 [B<-v>]
  12 [B<-vv>]
  13 [B<-vvv>]
  14 [B<-vvvv>]
  15 [B<-c>]
  16 [B<-t>]
  17 [B<-tt>]
  18 [B<-pre> I<command>] ...
  19 [B<-post> I<command>] ...
  20 [I<engine> ...]
  21
  22 =head1 DESCRIPTION
  23
  24 This command is used to query the status and capabilities
  25 of the specified I<engine>s.
  26 Engines may be specified before and after all other command-line flags.
  27 Only those specified are queried.
  28
  29 =head1 OPTIONS
  30
  31 =over 4
  32
  33 =item B<-help>
  34
  35 Display an option summary.
  36
  37 =item B<-v> B<-vv> B<-vvv> B<-vvvv>
  38
  39 Provides information about each specified engine. The first flag lists
  40 all the possible run-time control commands; the second adds a
  41 description of each command; the third adds the input flags, and the
  42 final option adds the internal input flags.
  43
  44 =item B<-c>
  45
  46 Lists the capabilities of each engine.
  47
  48 =item B<-t>
  49
  50 Tests if each specified engine is available, and displays the answer.
  51
  52 =item B<-tt>
  53
  54 Displays an error trace for any unavailable engine.
  55
  56 =item B<-pre> I<command>
  57
  58 =item B<-post> I<command>
  59
  60 Command-line configuration of engines.
  61 The B<-pre> command is given to the engine before it is loaded and
  62 the B<-post> command is given after the engine is loaded.
  63 The I<command> is of the form I<cmd>:I<val> where I<cmd> is the command,
  64 and I<val> is the value for the command.
  65 See the example below.
  66
  67 These two options are cumulative, so they may be given more than once in the
  68 same command.
  69
  70 =back
  71
  72 =head1 EXAMPLES
  73
  74 To list all the commands available to a dynamic engine:
  75
  76  $ openssl engine -t -tt -vvvv dynamic
  77  (dynamic) Dynamic engine loading support
  78       [ unavailable ]
  79       SO_PATH: Specifies the path to the new ENGINE shared library
  80            (input flags): STRING
  81       NO_VCHECK: Specifies to continue even if version checking fails (boolean)
  82            (input flags): NUMERIC
  83       ID: Specifies an ENGINE id name for loading
  84            (input flags): STRING
  85       LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
  86            (input flags): NUMERIC
  87       DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)
  88            (input flags): NUMERIC
  89       DIR_ADD: Adds a directory from which ENGINEs can be loaded
  90            (input flags): STRING
  91       LOAD: Load up the ENGINE specified by other settings
  92            (input flags): NO_INPUT
  93
  94 To list the capabilities of the B<rsax> engine:
  95
  96  $ openssl engine -c
  97  (rsax) RSAX engine support
  98   [RSA]
  99  (dynamic) Dynamic engine loading support
 100
 101 =head1 ENVIRONMENT
 102
 103 =over 4
 104
 105 =item B<OPENSSL_ENGINES>
 106
 107 The path to the engines directory.
 108
 109 =back
 110
 111 =head1 SEE ALSO
 112
 113 L<openssl(1)>,
 114 L<config(5)>
 115
 116 =head1 COPYRIGHT
 117
 118 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
 119
 120 Licensed under the Apache License 2.0 (the "License").  You may not use
 121 this file except in compliance with the License.  You can obtain a copy
 122 in the file LICENSE in the source distribution or at
 123 L<https://www.openssl.org/source/license.html>.
 124
 125 =cut