Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

opendkim-genkey(8) [debian man page]

opendkim-genkey(8)					      System Manager's Manual						opendkim-genkey(8)

NAME

       opendkim-genkey - DKIM filter key generation tool

SYNOPSIS

       opendkim-genkey [options]

DESCRIPTION

       opendkim-genkey	generates  (1)	a  private key for signing messages using opendkim(8) and (2) a DNS TXT record suitable for inclusion in a
       zone file which publishes the matching public key for use by remote DKIM verifiers.

       The filenames of these are based on the selector (see below); the private key will have a suffix of ".private" and the TXT record will have
       a suffix of ".txt".

OPTIONS

       -a     Appends  the  domain  name (see -d below) to the label in the generated TXT record, followed by a trailing period.  By default it is
	      assumed the domain name is implicit from the context of the zone file, and is therefore not included in the output.

       -b bits
	      Specifies the size of the key, in bits, to be generated.	The default is 1024 which is the value recommended by the DKIM	specifica-
	      tion.

       -d domain
	      Names  the  domain  which  will  use this key for signing.  Currently only used in a comment in the TXT record file.  The default is
	      "example.com".

       -D directory
	      Instructs the tool to change to the named directory prior to creating files.  By default the current directory is used.

       -h algorithms
	      Specifies a list of hash algorithms which can be used with this key.  By default all hash algorithms are allowed.

       -n note
	      Includes arbitrary note text in the key record.  By default, no such text is included.

       -r     Restricts the key for use in e-mail signing only.  The default is to allow the key to be used for any service.

       -s selector
	      Specifies the selector, or name, of the key pair generated.  The default is "default".

       -S     Disallows subdomain signing by this key.	By default the key record will be generated such that verifiers are told subdomain signing
	      is permitted.

       -t     Indicates the generated key record should be tagged such that verifiers are aware DKIM is in test at the signing domain.

NOTES

       Requires that the openssl(8) binary be installed and in the executing shell's search path.

VERSION

       This man page covers the version of opendkim-genkey that shipped with version 2.6.8 of OpenDKIM.

COPYRIGHT

       Copyright (c) 2007, 2008 Sendmail, Inc. and its suppliers.  All rights reserved.

       Copyright (c) 2009, 2011, 2012, The OpenDKIM Project.  All rights reserved.

SEE ALSO

       opendkim(8), openssl(8)

       RFC6376 - DomainKeys Identified Mail

							       The OpenDKIM Project						opendkim-genkey(8)

Check Out this Related Man Page

Mail::DKIM::PrivateKey(3)				User Contributed Perl Documentation				 Mail::DKIM::PrivateKey(3)

NAME

       Mail::DKIM::PrivateKey - a private key loaded in memory for DKIM signing

SYNOPSIS

	my $key1 = Mail::DKIM::PrivateKey->load(
		      File => "/path/to/private.key");

	my $key2 = Mail::DKIM::PrivateKey->load(
		      Data => $base64);

	# use the loaded key in a DKIM signing object
	my $dkim = Mail::DKIM::Signer->new(
		      Key => $key2,
		    );

CONSTRUCTOR

   load() - loads a private key into memory
	my $key1 = Mail::DKIM::PrivateKey->load(
		      File => "/path/to/private.key");

       Loads the Base64-encoded key from the specified file.

	 my $key2 = Mail::DKIM::PrivateKey->load(Data => $base64);

       Loads the Base64-encoded key from a string already in memory.

	 my $key3 = Mail::DKIM::PrivateKey->load(Cork => $openssl_object);

       Creates a Mail::DKIM::PrivateKey wrapper object for the given OpenSSL key object. The key object should be of type Crypt::OpenSSL::RSA.

METHODS

   cork() - access the underlying OpenSSL key object
	 $openssl_object = $key->cork;

       The returned object is of type Crypt::OpenSSL::RSA.

   sign_digest()
       Cryptographically sign the given message digest.

	 $key->sign_digest("SHA-1", sha1("my message text"));

       The first parameter is the name of the digest: one of "SHA-1", "SHA-256".

       The second parameter is the message digest as a binary string.

       The result should be the signed digest as a binary string.

AUTHOR

       Jason Long, <jlong@messiah.edu>

COPYRIGHT AND LICENSE

       Copyright (C) 2006-2008 by Messiah College

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or,
       at your option, any later version of Perl 5 you may have available.

perl v5.18.2							    2012-11-28						 Mail::DKIM::PrivateKey(3)
Man Page