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 The B<engine> command is used to query the status and capabilities
  25 of the specified B<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:val> where I<cmd> is the command,
  60 and I<val> is the value for the command.
  61 See the example below.
  62
  63 =back
  64
  65 =head1 EXAMPLES
  66
  67 To list all the commands available to a dynamic engine:
  68
  69  $ openssl engine -t -tt -vvvv dynamic
  70  (dynamic) Dynamic engine loading support
  71       [ unavailable ]
  72       SO_PATH: Specifies the path to the new ENGINE shared library
  73            (input flags): STRING
  74       NO_VCHECK: Specifies to continue even if version checking fails (boolean)
  75            (input flags): NUMERIC
  76       ID: Specifies an ENGINE id name for loading
  77            (input flags): STRING
  78       LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
  79            (input flags): NUMERIC
  80       DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)
  81            (input flags): NUMERIC
  82       DIR_ADD: Adds a directory from which ENGINEs can be loaded
  83            (input flags): STRING
  84       LOAD: Load up the ENGINE specified by other settings
  85            (input flags): NO_INPUT
  86
  87 To list the capabilities of the I<rsax> engine:
  88
  89  $ openssl engine -c
  90  (rsax) RSAX engine support
  91   [RSA]
  92  (dynamic) Dynamic engine loading support
  93
  94 =head1 ENVIRONMENT
  95
  96 =over 4
  97
  98 =item B<OPENSSL_ENGINES>
  99
 100 The path to the engines directory.
 101
 102 =back
 103
 104 =head1 SEE ALSO
 105
 106 L<openssl(1)>,
 107 L<config(5)>
 108
 109 =head1 COPYRIGHT
 110
 111 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
 112
 113 Licensed under the Apache License 2.0 (the "License").  You may not use
 114 this file except in compliance with the License.  You can obtain a copy
 115 in the file LICENSE in the source distribution or at
 116 L<https://www.openssl.org/source/license.html>.
 117
 118 =cut