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