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