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