Loading doc/apps/ec.pod 0 → 100644 +190 −0 Original line number Diff line number Diff line =pod =head1 NAME ec - EC key processing =head1 SYNOPSIS B<openssl> B<ec> [B<-inform PEM|DER>] [B<-outform PEM|DER>] [B<-in filename>] [B<-passin arg>] [B<-out filename>] [B<-passout arg>] [B<-des>] [B<-des3>] [B<-idea>] [B<-text>] [B<-noout>] [B<-param_out>] [B<-pubin>] [B<-pubout>] [B<-conv_form arg>] [B<-param_enc arg>] [B<-engine id>] =head1 DESCRIPTION The B<ec> command processes EC keys. They can be converted between various forms and their components printed out. B<Note> OpenSSL uses the private key format specified in 'SEC 1: Elliptic Curve Cryptography' (http://www.secg.org/). To convert a OpenSSL EC private key into the PKCS#8 private key format use the B<pkcs8> command. =head1 COMMAND OPTIONS =over 4 =item B<-inform DER|PEM> This specifies the input format. The B<DER> option with a private key uses an ASN.1 DER encoded SEC1 private key. When used with a public key it uses the SubjectPublicKeyInfo structur as specified in RFC 3280. The B<PEM> form is the default format: it consists of the B<DER> format base64 encoded with additional header and footer lines. In the case of a private key PKCS#8 format is also accepted. =item B<-outform DER|PEM> This specifies the output format, the options have the same meaning as the B<-inform> option. =item B<-in filename> This specifies the input filename to read a key from or standard input if this option is not specified. If the key is encrypted a pass phrase will be prompted for. =item B<-passin arg> the input file password source. For more information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. =item B<-out filename> This specifies the output filename to write a key to or standard output by is not specified. If any encryption options are set then a pass phrase will be prompted for. The output filename should B<not> be the same as the input filename. =item B<-passout arg> the output file password source. For more information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. =item B<-des|-des3|-idea> These options encrypt the private key with the DES, triple DES, IDEA or any other cipher supported by OpenSSL before outputting it. A pass phrase is prompted for. If none of these options is specified the key is written in plain text. This means that using the B<ec> utility to read in an encrypted key with no encryption option can be used to remove the pass phrase from a key, or by setting the encryption options it can be use to add or change the pass phrase. These options can only be used with PEM format output files. =item B<-text> prints out the public, private key components and parameters. =item B<-noout> this option prevents output of the encoded version of the key. =item B<-modulus> this option prints out the value of the public key component of the key. =item B<-pubin> by default a private key is read from the input file: with this option a public key is read instead. =item B<-pubout> by default a private key is output. With this option a public key will be output instead. This option is automatically set if the input is a public key. =item B<-conv_form> This specifies how the points on the elliptic curve are converted into octet strings. Possible values are: B<compressed> (the default value), B<uncompressed> and B<hybrid>. For more information regarding the point conversion forms please read the X9.62 standard. B<Note> Due to patent issues the B<compressed> option is disabled by default for binary curves and can be enabled by defining the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time. =item B<-param_enc arg> This specifies how the elliptic curve parameters are encoded. Possible value are: B<named_curve>, i.e. the ec parameters are specified by a OID, or B<explicit> where the ec parameters are explicitly given (see RFC 3279 for the definition of the EC parameters structures). The default value is B<named_curve>. B<Note> the B<implicitlyCA> alternative ,as specified in RFC 3279, is currently not implemented in OpenSSL. =item B<-engine id> specifying an engine (by it's unique B<id> string) will cause B<req> to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. =back =head1 NOTES The PEM private key format uses the header and footer lines: -----BEGIN EC PRIVATE KEY----- -----END EC PRIVATE KEY----- The PEM public key format uses the header and footer lines: -----BEGIN PUBLIC KEY----- -----END PUBLIC KEY----- =head1 EXAMPLES To encrypt a private key using triple DES: openssl ec -in key.pem -des3 -out keyout.pem To convert a private key from PEM to DER format: openssl ec -in key.pem -outform DER -out keyout.der To print out the components of a private key to standard output: openssl ec -in key.pem -text -noout To just output the public part of a private key: openssl ec -in key.pem -pubout -out pubkey.pem To change the parameters encoding to B<explicit>: openssl ec -in key.pem -param_enc explicit -out keyout.pem To change the point conversion form to B<compressed>: openssl ec -in key.pem -conv_form compressed -out keyout.pem =head1 SEE ALSO L<ecparam(1)|ecparam(1)>, L<dsa(1)|dsa(1)>, L<rsa(1)|rsa(1)> =head1 HISTORY The ec command was first introduced in OpenSSL 0.9.8. =head1 AUTHOR Nils Larsch for the OpenSSL project (http://www.openssl.org). =cut doc/apps/ecparam.pod 0 → 100644 +179 −0 Original line number Diff line number Diff line =pod =head1 NAME ecparam - EC parameter manipulation and generation =head1 SYNOPSIS B<openssl ecparam> [B<-inform DER|PEM>] [B<-outform DER|PEM>] [B<-in filename>] [B<-out filename>] [B<-noout>] [B<-text>] [B<-C>] [B<-check>] [B<-name arg>] [B<-list_curve>] [B<-conv_form arg>] [B<-param_enc arg>] [B<-no_seed>] [B<-rand file(s)>] [B<-genkey>] [B<-engine id>] =head1 DESCRIPTION This command is used to manipulate or generate EC parameter files. =head1 OPTIONS =over 4 =item B<-inform DER|PEM> This specifies the input format. The B<DER> option uses an ASN.1 DER encoded form compatible with RFC 3279 EcpkParameters. The PEM form is the default format: it consists of the B<DER> format base64 encoded with additional header and footer lines. =item B<-outform DER|PEM> This specifies the output format, the options have the same meaning as the B<-inform> option. =item B<-in filename> This specifies the input filename to read parameters from or standard input if this option is not specified. =item B<-out filename> This specifies the output filename parameters to. Standard output is used if this option is not present. The output filename should B<not> be the same as the input filename. =item B<-noout> This option inhibits the output of the encoded version of the parameters. =item B<-text> This option prints out the EC parameters in human readable form. =item B<-C> This option converts the EC parameters into C code. The parameters can then be loaded by calling the B<get_ec_group_XXX()> function. =item B<-check> Validate the elliptic curve parameters. =item B<-name arg> Use the EC parameters with the specified 'short' name. Use B<-list_curves> to get a list of all currently implemented EC parameters. =item B<-list_curves> If this options is specified B<ecparam> will print out a list of all currently implemented EC parameters names and exit. =item B<-conv_form> This specifies how the points on the elliptic curve are converted into octet strings. Possible values are: B<compressed> (the default value), B<uncompressed> and B<hybrid>. For more information regarding the point conversion forms please read the X9.62 standard. B<Note> Due to patent issues the B<compressed> option is disabled by default for binary curves and can be enabled by defining the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time. =item B<-param_enc arg> This specifies how the elliptic curve parameters are encoded. Possible value are: B<named_curve>, i.e. the ec parameters are specified by a OID, or B<explicit> where the ec parameters are explicitly given (see RFC 3279 for the definition of the EC parameters structures). The default value is B<named_curve>. B<Note> the B<implicitlyCA> alternative ,as specified in RFC 3279, is currently not implemented in OpenSSL. =item B<-no_seed> This option inhibits that the 'seed' for the parameter generation is included in the ECParameters structure (see RFC 3279). =item B<-genkey> This option will generate a EC private key using the specified parameters. =item B<-rand file(s)> a file or files containing random data used to seed the random number generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>). Multiple files can be specified separated by a OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. =item B<-engine id> specifying an engine (by it's unique B<id> string) will cause B<req> to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. =back =head1 NOTES PEM format EC parameters use the header and footer lines: -----BEGIN EC PARAMETERS----- -----END EC PARAMETERS----- OpenSSL is currently not able to generate new groups and therefore B<ecparam> can only create EC parameters from known (named) curves. =head1 EXAMPLES To create EC parameters with the group 'prime192v1': openssl ec -out ec_param.pem -name prime192v1 To create EC parameters with explicit parameters: openssl ec -out ec_param.pem -name prime192v1 -param_enc explicit To validate given EC parameters: openssl ec -in ec_param.pem -check To create EC parameters and a private key: openssl ec -out ec_key.pem -name prime192v1 -genkey To change the point encoding to 'compressed': openssl ec -in ec_in.pem -out ec_out.pem -conv_form compressed To print out the EC parameters to standard output: openssl ec -in ec_param.pem -noout -text =head1 SEE ALSO L<ec(1)|ec(1)>, L<dsaparam(1)|dsaparam(1)> =head1 HISTORY The ecparam command was first introduced in OpenSSL 0.9.8. =head1 AUTHOR Nils Larsch for the OpenSSL project (http://www.openssl.org) =cut Loading
doc/apps/ec.pod 0 → 100644 +190 −0 Original line number Diff line number Diff line =pod =head1 NAME ec - EC key processing =head1 SYNOPSIS B<openssl> B<ec> [B<-inform PEM|DER>] [B<-outform PEM|DER>] [B<-in filename>] [B<-passin arg>] [B<-out filename>] [B<-passout arg>] [B<-des>] [B<-des3>] [B<-idea>] [B<-text>] [B<-noout>] [B<-param_out>] [B<-pubin>] [B<-pubout>] [B<-conv_form arg>] [B<-param_enc arg>] [B<-engine id>] =head1 DESCRIPTION The B<ec> command processes EC keys. They can be converted between various forms and their components printed out. B<Note> OpenSSL uses the private key format specified in 'SEC 1: Elliptic Curve Cryptography' (http://www.secg.org/). To convert a OpenSSL EC private key into the PKCS#8 private key format use the B<pkcs8> command. =head1 COMMAND OPTIONS =over 4 =item B<-inform DER|PEM> This specifies the input format. The B<DER> option with a private key uses an ASN.1 DER encoded SEC1 private key. When used with a public key it uses the SubjectPublicKeyInfo structur as specified in RFC 3280. The B<PEM> form is the default format: it consists of the B<DER> format base64 encoded with additional header and footer lines. In the case of a private key PKCS#8 format is also accepted. =item B<-outform DER|PEM> This specifies the output format, the options have the same meaning as the B<-inform> option. =item B<-in filename> This specifies the input filename to read a key from or standard input if this option is not specified. If the key is encrypted a pass phrase will be prompted for. =item B<-passin arg> the input file password source. For more information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. =item B<-out filename> This specifies the output filename to write a key to or standard output by is not specified. If any encryption options are set then a pass phrase will be prompted for. The output filename should B<not> be the same as the input filename. =item B<-passout arg> the output file password source. For more information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. =item B<-des|-des3|-idea> These options encrypt the private key with the DES, triple DES, IDEA or any other cipher supported by OpenSSL before outputting it. A pass phrase is prompted for. If none of these options is specified the key is written in plain text. This means that using the B<ec> utility to read in an encrypted key with no encryption option can be used to remove the pass phrase from a key, or by setting the encryption options it can be use to add or change the pass phrase. These options can only be used with PEM format output files. =item B<-text> prints out the public, private key components and parameters. =item B<-noout> this option prevents output of the encoded version of the key. =item B<-modulus> this option prints out the value of the public key component of the key. =item B<-pubin> by default a private key is read from the input file: with this option a public key is read instead. =item B<-pubout> by default a private key is output. With this option a public key will be output instead. This option is automatically set if the input is a public key. =item B<-conv_form> This specifies how the points on the elliptic curve are converted into octet strings. Possible values are: B<compressed> (the default value), B<uncompressed> and B<hybrid>. For more information regarding the point conversion forms please read the X9.62 standard. B<Note> Due to patent issues the B<compressed> option is disabled by default for binary curves and can be enabled by defining the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time. =item B<-param_enc arg> This specifies how the elliptic curve parameters are encoded. Possible value are: B<named_curve>, i.e. the ec parameters are specified by a OID, or B<explicit> where the ec parameters are explicitly given (see RFC 3279 for the definition of the EC parameters structures). The default value is B<named_curve>. B<Note> the B<implicitlyCA> alternative ,as specified in RFC 3279, is currently not implemented in OpenSSL. =item B<-engine id> specifying an engine (by it's unique B<id> string) will cause B<req> to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. =back =head1 NOTES The PEM private key format uses the header and footer lines: -----BEGIN EC PRIVATE KEY----- -----END EC PRIVATE KEY----- The PEM public key format uses the header and footer lines: -----BEGIN PUBLIC KEY----- -----END PUBLIC KEY----- =head1 EXAMPLES To encrypt a private key using triple DES: openssl ec -in key.pem -des3 -out keyout.pem To convert a private key from PEM to DER format: openssl ec -in key.pem -outform DER -out keyout.der To print out the components of a private key to standard output: openssl ec -in key.pem -text -noout To just output the public part of a private key: openssl ec -in key.pem -pubout -out pubkey.pem To change the parameters encoding to B<explicit>: openssl ec -in key.pem -param_enc explicit -out keyout.pem To change the point conversion form to B<compressed>: openssl ec -in key.pem -conv_form compressed -out keyout.pem =head1 SEE ALSO L<ecparam(1)|ecparam(1)>, L<dsa(1)|dsa(1)>, L<rsa(1)|rsa(1)> =head1 HISTORY The ec command was first introduced in OpenSSL 0.9.8. =head1 AUTHOR Nils Larsch for the OpenSSL project (http://www.openssl.org). =cut
doc/apps/ecparam.pod 0 → 100644 +179 −0 Original line number Diff line number Diff line =pod =head1 NAME ecparam - EC parameter manipulation and generation =head1 SYNOPSIS B<openssl ecparam> [B<-inform DER|PEM>] [B<-outform DER|PEM>] [B<-in filename>] [B<-out filename>] [B<-noout>] [B<-text>] [B<-C>] [B<-check>] [B<-name arg>] [B<-list_curve>] [B<-conv_form arg>] [B<-param_enc arg>] [B<-no_seed>] [B<-rand file(s)>] [B<-genkey>] [B<-engine id>] =head1 DESCRIPTION This command is used to manipulate or generate EC parameter files. =head1 OPTIONS =over 4 =item B<-inform DER|PEM> This specifies the input format. The B<DER> option uses an ASN.1 DER encoded form compatible with RFC 3279 EcpkParameters. The PEM form is the default format: it consists of the B<DER> format base64 encoded with additional header and footer lines. =item B<-outform DER|PEM> This specifies the output format, the options have the same meaning as the B<-inform> option. =item B<-in filename> This specifies the input filename to read parameters from or standard input if this option is not specified. =item B<-out filename> This specifies the output filename parameters to. Standard output is used if this option is not present. The output filename should B<not> be the same as the input filename. =item B<-noout> This option inhibits the output of the encoded version of the parameters. =item B<-text> This option prints out the EC parameters in human readable form. =item B<-C> This option converts the EC parameters into C code. The parameters can then be loaded by calling the B<get_ec_group_XXX()> function. =item B<-check> Validate the elliptic curve parameters. =item B<-name arg> Use the EC parameters with the specified 'short' name. Use B<-list_curves> to get a list of all currently implemented EC parameters. =item B<-list_curves> If this options is specified B<ecparam> will print out a list of all currently implemented EC parameters names and exit. =item B<-conv_form> This specifies how the points on the elliptic curve are converted into octet strings. Possible values are: B<compressed> (the default value), B<uncompressed> and B<hybrid>. For more information regarding the point conversion forms please read the X9.62 standard. B<Note> Due to patent issues the B<compressed> option is disabled by default for binary curves and can be enabled by defining the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time. =item B<-param_enc arg> This specifies how the elliptic curve parameters are encoded. Possible value are: B<named_curve>, i.e. the ec parameters are specified by a OID, or B<explicit> where the ec parameters are explicitly given (see RFC 3279 for the definition of the EC parameters structures). The default value is B<named_curve>. B<Note> the B<implicitlyCA> alternative ,as specified in RFC 3279, is currently not implemented in OpenSSL. =item B<-no_seed> This option inhibits that the 'seed' for the parameter generation is included in the ECParameters structure (see RFC 3279). =item B<-genkey> This option will generate a EC private key using the specified parameters. =item B<-rand file(s)> a file or files containing random data used to seed the random number generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>). Multiple files can be specified separated by a OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. =item B<-engine id> specifying an engine (by it's unique B<id> string) will cause B<req> to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. =back =head1 NOTES PEM format EC parameters use the header and footer lines: -----BEGIN EC PARAMETERS----- -----END EC PARAMETERS----- OpenSSL is currently not able to generate new groups and therefore B<ecparam> can only create EC parameters from known (named) curves. =head1 EXAMPLES To create EC parameters with the group 'prime192v1': openssl ec -out ec_param.pem -name prime192v1 To create EC parameters with explicit parameters: openssl ec -out ec_param.pem -name prime192v1 -param_enc explicit To validate given EC parameters: openssl ec -in ec_param.pem -check To create EC parameters and a private key: openssl ec -out ec_key.pem -name prime192v1 -genkey To change the point encoding to 'compressed': openssl ec -in ec_in.pem -out ec_out.pem -conv_form compressed To print out the EC parameters to standard output: openssl ec -in ec_param.pem -noout -text =head1 SEE ALSO L<ec(1)|ec(1)>, L<dsaparam(1)|dsaparam(1)> =head1 HISTORY The ecparam command was first introduced in OpenSSL 0.9.8. =head1 AUTHOR Nils Larsch for the OpenSSL project (http://www.openssl.org) =cut
