doc/man1/engine.pod

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