The Security Module Database Tool is a command-line utility for managing PKCS #11 module information within
secmod.db files or within hardware tokens. You can use the tool to add and delete PKCS #11 modules,
change passwords, set defaults, list module contents, enable or disable slots, enable or disable FIPS 140-2
compliance, and assign default providers for cryptographic operations. This tool can also create
key3.db, cert8.db, and secmod.db security database files.
key3.db files) and certificate databases (cert8.db files). The
key, certificate, and PKCS #11 module management process generally begins with creating the keys and key database
necessary to generate and manage certificates and the certificate database.
This document discusses security module database management. For information on certificate database and key
database management, see Using the Certificate Database Tool.
modutiloption [arguments]
where option and arguments are combinations of the options and arguments listed in the following
section. Each command takes one option. Each option may take zero or more arguments. To see a usage string, issue
the command without options.
modutil
command are defined as follows:
key3.db, cert8.db, and
secmod.db):
-create
-list [modulename]
-addmodulename-libfilelibrary-file[-cipherscipher-enable-list]mechanism-list
[-mechanisms]
-jarJAR-file-installdirroot-installation-directory
[-tempdirtemporary-directory]
-deletemodulename
-changepwtokenname[-pwfileold-password-file]new-password-file
[-newpwfile]
-defaultmodulename-mechanismsmechanism-list
-undefaultmodulename-mechanismsmechanism-list
-enablemodulename[-slotslotname]
-disablemodulename[-slotslotname]
-fips [true | false]
-force
Pkcs11_install_script. To declare meta-information in
the manifest file, put it in a file that is passed to the Netscape Signing Tool.
pk11install. If so, the metainfo file
for the Netscape Signing
Tool would include a line such as this:
+ Pkcs11_install_script: pk11installForwardCompatible { IRIX:6.2:mips SUNOS:5.5.1:sparc }
Platforms {
WINNT::x86 {
ModuleName { "Fortezza Module" }
ModuleFile { win32/fort32.dll }
DefaultMechanismFlags{0x0001}
DefaultCipherFlags{0x0001}
Files {
win32/setup.exe {
Executable
RelativePath { %temp%/setup.exe }
}
win32/setup.hlp {
RelativePath { %temp%/setup.hlp }
}
win32/setup.cab {
RelativePath { %temp%/setup.cab }
}
}
}
WIN95::x86 {
EquivalentPlatform {WINNT::x86}
}
SUNOS:5.5.1:sparc {
ModuleName { "Fortezza UNIX Module" }
ModuleFile { unix/fort.so }
DefaultMechanismFlags{0x0001}
CipherEnableFlags{0x0001}
Files {
unix/fort.so {
RelativePath{%root%/lib/fort.so}
AbsolutePath{/usr/local/netscape/lib/fort.so}
FilePermissions{555}
}
xplat/instr.html {
RelativePath{%root%/docs/inst.html}
AbsolutePath{/usr/local/netscape/docs/inst.html}
FilePermissions{555}
}
}
}
IRIX:6.2:mips {
EquivalentPlatform { SUNOS:5.5.1:sparc }
}
}
--> valuelistvaluelist-->value valuelist<null>
value--->key_value_pair
string
key_value_pair-->key{valuelist}
key --> string
string-->simple_string"complex_string"
simple_string --> [^ \t\n\""{""}"]+
(No whitespace, quotes, or braces.)
complex_stringOutside of complex strings, all white space (for example, spaces, tabs, and carriage returns) is considered equal and is used only to delimit tokens.--> ([^\"\\\r\n]|(\\\")|(\\\\))+(Quotes and
backslashes must be escaped with a backslash. A complex string must not
include newlines or carriage returns.)
ForwardCompatible
Gives a list of platforms that are forward compatible. If the current platform cannot be found in the list of
supported platforms, then the ForwardCompatible list is checked for any platforms that have the same OS
and architecture in an earlier version. If one is found, its attributes are used for the current platform.
Platforms (required)
Gives a list of platforms. Each entry in the list is itself a key-value pair: the key is the name of the platform
and the value list contains various attributes of the platform. The ModuleName,
ModuleFile, and Files attributes must be specified for each platform unless an
EquivalentPlatform attribute is specified. The platform string is in the following format: system
name:OS release:architecture. The installer obtains these values
from NSPR. OS release is an empty string on non-Unix operating systems. The following system names and
platforms are currently defined by NSPR:
IRIX:6.2:mips
SUNOS:5.5.1:sparc
Linux:2.0.32:x86
WIN95::x86.
Platforms list.
ModuleName (required)
Gives the common name for the module. This name will be used to reference the module from Netscape Communicator, the
Security Module Database tool (modutil), servers, or any other program that uses the Netscape security
module database.
ModuleFile (required)
Names the PKCS #11 module file (DLL or .so) for this platform. The name is given as the relative path
of the file within the JAR archive.
Files (required)
Lists the files that need to be installed for this module. Each entry in the file list is a key-value pair: the key
is the path of the file in the JAR archive, and the value list contains attributes of the file. At least
RelativePath or AbsolutePath must be specified for each file.
DefaultMechanismFlags
Specifies mechanisms for which this module will be a default provider. This key-value pair is a bitstring specified
in hexadecimal (0x) format. It is constructed as a bitwise OR of the following constants. If the
DefaultMechanismFlags entry is omitted, the value defaults to 0x0.
RSA: 0x00000001
DSA: 0x00000002
RC2: 0x00000004
RC4: 0x00000008
DES: 0x00000010
DH: 0x00000020
FORTEZZA: 0x00000040
RC5: 0x00000080
SHA1: 0x00000100
MD5: 0x00000200
MD2: 0x00000400
RANDOM: 0x08000000
FRIENDLY: 0x10000000
OWN_PW_DEFAULTS: 0x20000000
DISABLE: 0x40000000CipherEnableFlags
Specifies ciphers that this module provides but Netscape Communicator does not, so that Communicator can enable
them. This key is a bitstring specified in hexadecimal (0x) format. It is constructed as a bitwise OR of the
following constants. If the CipherEnableFlags entry is omitted, the value defaults to 0x0.
FORTEZZA: 0x0000 0001
EquivalentPlatform
Specifies that the attributes of the named platform should also be used for the current platform. Saves typing when
there is more than one platform using the same settings.
Files list. At least one of
RelativePath and AbsolutePath must be specified. If both are specified, the relative path
is tried first, and the absolute path is used only if no relative root directory is provided by the installer
program.
RelativePath
Specifies the destination directory of the file, relative to some directory decided at install time. Two variables
can be used in the relative path: "%root%" and "%temp%". "%root%" is replaced
at run time with the directory relative to which files should be installed; for example, it may be the server's root
directory or the Netscape Communicator root directory. The "%temp%" directory is created at the
beginning of the installation and destroyed at the end.
The purpose of "%temp%" is to hold executable files (such as setup programs) or files that are used by
these programs. For example, a Windows installation might consist of a setup.exe installation program,
a help file, and a .cab file containing compressed information. All these files could be installed in
the temporary directory. Files destined for the temporary directory are guaranteed to be in place before any
executable file is run; they are not deleted until all executable files have finished.
AbsolutePath
Specifies the destination directory of the file as an absolute path. If both RelativePath and
AbsolutePath are specified, the installer attempts to use the relative path; if it is unable to
determine a relative path, it uses the absolute path.
Executable
Specifies that the file is to be executed during the course of the installation. Typically this string would be used
for a setup program provided by a module vendor, such as a self-extracting setup.exe. More than one
file can be specified as executable, in which case the files are run in the order in which they are specified in the
script file.
FilePermissions
Interpreted as a string of octal digits, according to the standard Unix format. This string is a bitwise OR of the
following constants:
user read: 0400Some platforms may not understand these permissions. They are applied only insofar as they make sense for the current platform. If this attribute is omitted, a default of 777 is assumed.
user write: 0200
user execute: 0100
group read: 0040
group write: 0020
group execute: 0010
other read: 0004
other write: 0002
other execute: 0001
modutil -create -dbdir c:\databasesThe Security Module Database Tool displays a warning:
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Creating "c:\databases\key3.db"...done.
Creating "c:\databases\cert8.db"...done.
Creating "c:\databases\secmod.db"...done.
modutil -list "Netscape Internal PKCS #11 Module" -dbdir c:\databasesThe Security Module Database Tool displays information similar to this:
Using database directory c:\databases...
--------------------------------------------------------
Name: Netscape Internal PKCS #11 Module
Library file: **Internal ONLY module**
Manufacturer: Netscape Communications Corp
Description: Communicator Internal Crypto Svc
PKCS #11 Version 2.0
Library Version: 4.0
Cipher Enable Flags: None
Default Mechanism Flags: RSA:DSA:RC2:RC4:DES:SHA1:MD5:MD2
Slot: Communicator Internal Cryptographic Services Version 4.0
Manufacturer: Netscape Communications Corp
Type: Software
Version Number: 4.1
Firmware Version: 0.0
Status: Enabled
Token Name: Communicator Generic Crypto Svcs
Token Manufacturer: Netscape Communications Corp
Token Model: Libsec 4.0
Token Serial Number: 0000000000000000
Token Version: 4.0
Token Firmware Version: 0.0
Access: Write Protected
Login Type: Public (no login required)
User Pin: NOT Initialized
Slot: Communicator User Private Key and Certificate Services
Manufacturer: Netscape Communications Corp
Type: Software
Version Number: 3.0
Firmware Version: 0.0
Status: Enabled
Token Name: Communicator Certificate DB
Token Manufacturer: Netscape Communications Corp
Token Model: Libsec 4.0
Token Serial Number: 0000000000000000
Token Version: 7.0
Token Firmware Version: 0.0
Access: NOT Write Protected
Login Type: Login required
User Pin: NOT Initialized
modutil -default "Cryptographic Module" -dbdirThe Security Module Database Tool displays a warning:
c:\databases -mechanisms RSA:DSA:RC2
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Using database directory c:\databases...
Successfully changed defaults.
modutil -enable "Cryptographic Module" -slotThe Security Module Database Tool displays a warning:
"Cryptographic Reader" -dbdir c:\databases
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Using database directory c:\databases...
Slot "Cryptographic Reader" enabled.
modutil -dbdir "C:\databases" -fips trueThe Security Module Database Tool displays a warning:
WARNING: Performing this operation while the browser is running could causeAfter you press Enter, the tool displays the following:
corruption of your security databases. If the browser is currently running,
you should exit browser before continuing this operation. Type
'q <enter>' to abort, or <enter> to continue:
FIPS mode enabled.
C:\modutil> modutil -dbdir "C:\databases" -add "Cryptorific Module" -The Security Module Database Tool displays a warning:
libfile "C:\winnt\system32\crypto.dll" -mechanisms RSA:DSA:RC2:RANDOM
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Using database directory C:\databases...
Module "Cryptorific Module" added to database.
C:\modutil>
Platforms {
WinNT::x86 {
ModuleName { "Cryptorific Module" }
ModuleFile { crypto.dll }
DefaultMechanismFlags{0x0000}
CipherEnableFlags{0x0000}
Files {
crypto.dll {
RelativePath{ %root%/system32/crypto.dll }
}
setup.exe {
Executable
RelativePath{ %temp%/setup.exe }
}
}
}
Win95::x86 {
EquivalentPlatform { Winnt::x86 }
}
}
To install from the script, use the following command. The root directory should be the Windows root directory (for
example, c:\\windows, or c:\\winnt).
C:\modutil> modutil -dbdir "c:\databases" -jarThe Security Module Database Tool displays a warning:
install.jar -installdir "C:/winnt"
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Using database directory c:\databases...
This installation JAR file was signed by:
----------------------------------------------
**SUBJECT NAME**
C=US, ST=California, L=Mountain View, CN=Cryptorific Inc., OU=Digital ID
Class 3 - Netscape Object Signing, OU="www.verisign.com/repository/CPS
Incorp. by Ref.,LIAB.LTD(c)9 6", OU=www.verisign.com/CPS Incorp.by Ref
. LIABILITY LTD.(c)97 VeriSign, OU=VeriSign Object Signing CA - Class 3
Organization, OU="VeriSign, Inc.", O=VeriSign Trust Network **ISSUER
NAME**, OU=www.verisign.com/CPS Incorp.by Ref. LIABILITY LTD.(c)97
VeriSign, OU=VeriSign Object Signing CA - Class 3 Organization,
OU="VeriSign, Inc.", O=VeriSign Trust Network
----------------------------------------------
Do you wish to continue this installation? (y/n) y
Using installer script "installer_script"
Successfully parsed installation script
Current platform is WINNT::x86
Using installation parameters for platform WinNT::x86
Installed file crypto.dll to C:/winnt/system32/crypto.dll
Installed file setup.exe to ./pk11inst.dir/setup.exe
Executing "./pk11inst.dir/setup.exe"...
"./pk11inst.dir/setup.exe" executed successfully
Installed module "Cryptorific Module" into module database
Installation completed successfully
C:\modutil>
C:\modutil> modutil -dbdir "c:\databases" -changepwThe Security Module Database Tool displays a warning:
"Communicator Certificate DB"
WARNING: Performing this operation while Communicator is running couldAfter you press Enter, the tool displays the following:
cause corruption of your security databases. If Communicator is
currently running, you should exit Communicator before continuing this
operation. Type 'q <enter>' to abort, or <enter> to continue:
Using database directory c:\databases...
Enter old password:
Incorrect password, try again...
Enter old password:
Enter new password:
Re-enter new password:
Token "Communicator Certificate DB" password changed successfully.
C:\modutil>