doc/man1/openssl-engine.pod.in

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