Base64 Database Archiver

Fully qualified class name: ARCHIVERS=org.signserver.server.archive.base64dbarchiver.Base64DatabaseArchiver

Overview

This Archiver archives to the database table ArchiveData using the same datasource as SignServer uses for accessing the database for its configuration and other elements. It is similar to the Old Database Archiver but does not use an XML structure for storing the data. Instead, the data is simply base64 encoded.

Worker Properties

Property	Default	Description
ARCHIVERx.ARCHIVE_OF_TYPE	RESPONSE	Where "x" is the index of the Archiver in the `ARCHIVERS` property. Determines what this Archiver should archive. Valid values: REQUEST RESPONSE REQUEST_AND_RESPONSE Example: CODE `ARCHIVER0.ARCHIVE_OF_TYPE=REQUEST_AND_RESPONSE`
ARCHIVERx.USE_FORWARDED_ADDRESS	false	Where "x" is the index of the archiver in the `ARCHIVERS` property. If this property is set to true, IP addresses in the comma-separated list given in the X-Forwarded-For header is used as the remote IP stored in the archive in case this header is set (by default, the last forwarded address is used). If the header is not included, the IP address the request comes from is used (the same behavior as when this property is not set, or set to false. This is useful when running a proxy in front of SignServer to record the original IP address of the client, instead of the proxy's IP address.
ARCHIVERx.MAX_FORWARDED_ADDRESSES	1 (only include the last address)	Where "x" is the index of the archiver in the `ARCHIVERS` property. Sets the maximum number of forwarded addresses to add the remote IP in the archive, counted from the end. The addresses are listed in the order they appear in the header. This property is only used when `USE_FORWARDED_ADDRESS` is set to true.
ARCHIVERx.INCLUDE_DIRECT_ADDRESS	false (not included)	Where "x" is the index of the archiver in the `ARCHIVERS` property. When both this property and `USE_FORWARDED_ADDRESS` is set to true, the host IP address (direct address) is added to the end of the list of forwarded addresses. This address is not taken into account for the number of forwarded addresses by `MAX_FORWARDED_ADDRESSES` above. This property is only used when `USE_FORWARDED_ADDRESS` is set to true.

ArchiveData table

The exact database table structure is described in the SQL scripts available under doc/sql-scripts/.

Database table	Description
archiveData	Specifies the actual data encoded in an Base64PutHashMap.
archiveId	Specifies the identifier for the produced item. For the TimeStampSigner, this would be the Time stamp token serial number (in hex encoding). Other signers might use a hash of the request document and the transaction ID.
dataEncoding	Shows that the type of encoding uses a plain Base64 encoding of the binary data: `1 - DATA_ENCODING_BASE64`
requestCertSerialnumber	Specifies the serial number (in hex encoding) of the client certificate (if any) used by the client. This only indicates that the client certificate was used when establishing the connection to the web server, and not whether the worker required a client certificate or not, nor if it checked if the authenticated client was authorized.
requestIP	By default, the `requestIP` is the IP address of the connecting host. When `USE_FORWARDED_ADDRESS` is set to true, this contains a list of forwarded IP addresses from X-Forwarded-For optionally ending with the host address (when setting `INCLUDE_DIRECT_ADDRESS` to true).
requestIssuerDN	Specifies the Issuer DN (in string representation) of the issuer of the client certificate (if any) used by the client. See also note about requestCertSerialnumber.
signerId	Specifies the ID of the worker handling the request.
time	Specifies the time stamp (number of milliseconds since January 1 1970 00:00:00) on the SignServer host when the item was archived.
type	Specifies the type of archivable item. Valid values: `0 - TYPE_RESPONSE` `1 - TYPE_REQUEST`
uniqueId	Specifies the primary key of the archive row.