PAdES Signer Properties

info

See the Common Properties for configuration options of the AdES Signer.

The implementation class of the PAdES Signer is:

com.czertainly.signserver.module.pades.signer.PAdESSigner

It contains the integration with the DSS framework and extends the Worker interface of the SignServer. If you want to use the PAdES Signer, you must specify this property. The PAdES Signer will check the following configuration properties.

Property	Description	Default Value	Mandatory	Metadata Support
SIGNATURE_SIZE	Configuration option for the signature size in case the default size is not enough for larger PDF files. You can set the custom signature size in bytes.	18944	NO	YES
ADD_VISIBLE_SIGNATURE	Include visible signature in the signed PDF file. For more information about the configuration options for visible signatures, see the section Visible signature properties below.	false	NO	YES
REASON	Sets the reason.	NONE	NO	YES
LOCATION	Sets location (The CPU host name or physical location of the signing).	NONE	NO	YES
CONTACT_INFO	Sets the contact information.	NONE	NO	YES
SIGNER_NAME	Sets the name of the signed entity.	NONE	NO	YES
CERTIFICATION_PERMISSION	Certification signature creation with one of the following values (see "12.8.2.2 DocMDP" of ISO 32000-1): NO_CHANGE_PERMITTED (DocMDP value "1") - No changes to the document are permitted; any change to the document shall invalidate the signature. MINIMAL_CHANGES_PERMITTED (DocMDP value "2") - Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature. CHANGES_PERMITTED (DocMDP value "3") - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.	NONE	NO	YES

Visible signature properties

Visible signature properties are used to define the appearance of the signature field in the PDF document. They can be used to set the image, text, alignment, and other visual aspects of the signature.

At least image or text must be provided to create a visible signature field:

Property	Description	Default Value	Mandatory	Metadata Support
VISIBLE_SIGNATURE_ IMAGE_BASE64	Sets the custom image for signature field from Base64 encoded custom data.	NONE	NO	YES
VISIBLE_SIGNATURE_ IMAGE_PATH	Sets the custom image for signature field from path.	NONE	NO	YES
VISIBLE_SIGNATURE_ IMAGE_MIME_TYPE	Sets the MIME type of the custom image used for signature field.	image/png	NO	YES
VISIBLE_SIGNATURE_ TEXT	Sets the text to be displayed in the signature field.	NONE	NO	YES

You can specify additional properties:

• Positioning properties to define the position of the signature field on the page.
• Field properties to define the field where the signature will be placed.
• Text properties to define the text that will be displayed in the signature field.

Positioning properties:

Property	Description	Default Value	Mandatory	Metadata Support
VISIBLE_SIGNATURE_ ALIGNMENT_HORIZONTAL	Sets the horizontal alignment of a signature field to a page. Allows the following values: NONE - None alignment is applied, coordinates are counted from the left page side LEFT - The signature is aligned to the left side, coordinated are counted from the left page side CENTER - The signature is aligned to the center of the page, coordinates are counted automatically RIGHT - The signature is aligned to the right side, coordinates are counted from the right page side	NONE	NO	YES
VISIBLE_SIGNATURE_ ALIGNMENT_VERTICAL	Sets the vertical alignment of a signature field to a page. Allows the following values: NONE - None alignment is applied, coordinated are counted from the top side of a page TOP - The signature is aligned to a top side, coordinated are counted from the top page side MIDDLE - The signature aligned to a middle of a page, coordinated are counted automatically BOTTOM - The signature is aligned to a bottom side, coordinated are counted from the bottom page side	NONE	NO	YES
VISIBLE_SIGNATURE_ ZOOM	Sets the zoom of the image. The value is applied to width and height of a signature field. The value must be defined in percentage.	100	NO	YES
VISIBLE_SIGNATURE_ BACKGROUND_COLOR	Specifies the background color of the signature field. The color is specified in the hexadecimal format #AARRGGBB.	NONE	NO	YES
VISIBLE_SIGNATURE_ IMAGE_SCALING	Specifies the image scaling behavior within the signature field. Allowed values are: STRETCH - Stretches the image in both directions in order to fill the signature field box ZOOM_AND_CENTER - Zooms the image to fill the signature box to the closest side, and centers in another dimension CENTER - Centers the image in both dimensions	STRETCH	NO	YES
VISIBLE_SIGNATURE_ DPI	Sets an expected DPI value. If not used, the default dpi of the provided image is applied.	NONE	NO	YES

Field properties

Property	Description	Default Value	Mandatory	Metadata Support
VISIBLE_SIGNATURE_ FIELD_ID	Sets a signature field id/name to place a signature into. When used, the other field properties are ignored.	NONE	NO	YES
VISIBLE_SIGNATURE_ PAGE	Sets a page number where the signature field should be placed. The counting starts from 1 (one) for the first page of the document.	1	NO	YES
VISIBLE_SIGNATURE_ ORIGIN_X	Specify a margin between the left page side and a signature field (if no rotation and alignment is applied).	10	NO	YES
VISIBLE_SIGNATURE_ ORIGIN_Y	Specify a margin between the top page side and a signature field (if no rotation and alignment is applied).	10	NO	YES
VISIBLE_SIGNATURE_ WIDTH	Sets precise signature field's width in pixels. If not defined, the default image/text width will be used.	NONE	NO	YES
VISIBLE_SIGNATURE_ HEIGHT	Sets precise signature field's height in pixels. If not defined, the default image/text height will be used.	NONE	NO	YES
VISIBLE_SIGNATURE_ ROTATION	Sets the rotation of the signature field. Allows the following values: NONE - No rotation is applied. The origin of coordinates begins from the top left corner of a page AUTOMATIC - Rotates a signature field respectively to the page's rotation. Rotates the signature field on the same value as defined in a PDF page ROTATE_90 - Rotates a signature field for a 90 degrees clockwise. Coordinates' origin begins from top right page corner ROTATE_180 - Rotates a signature field for a 180 degrees clockwise. Coordinates' origin begins from bottom right page corner ROTATE_270 - Rotates a signature field for a 270 degrees clockwise. Coordinates' origin begins from bottom left page corner	NONE	NO	YES

Text properties

Property	Description	Default Value	Mandatory	Metadata Support
VISIBLE_SIGNATURE_ TEXT_COLOR	Sets the color of the text in the signature field. The color is specified in the hexadecimal format #AARRGGBB.	#00000000	NO	YES
VISIBLE_SIGNATURE_ TEXT_BACKGROUND_COLOR	Sets the background color for the area filled out by the text. The color is specified in the hexadecimal format #AARRGGBB.	#ffffffff	NO	YES
VISIBLE_SIGNATURE_ PADDING	Sets the padding in pixels between the text and a border of its bounding area	5	NO	YES
VISIBLE_SIGNATURE_ TEXT_WRAPPING	Sets the text wrapping behavior within the signature field. Allowed values are: FONT_BASED - The text is computed based on the given font size FILL_BOX - Finds optimal font size to wrap the text to a signature field box FILL_BOX_AND_LINEBREAK - Breaks the words to multiple lines in order to find the biggest possible font size to wrap the text into a signature field box	FONT_BASED	NO	YES
VISIBLE_SIGNATURE_ SIGNER_TEXT_POSITION	Specifies a text position relatively to an image. Applicable only for joint image/text signature field. Allowed values are: LEFT - The text will be placed on the left side, and image will be aligned to the right side inside the signature field RIGHT - The text will be placed on the right side, and image will be aligned to the left side inside the signature field TOP - Text is placed above the image BOTTOM - Text is placed below the image	LEFT	NO	YES
VISIBLE_SIGNATURE_ SIGNER_TEXT_HORIZONTAL_ALIGNMENT	Specifies a horizontal alignment of a text with respect to its area. Applicable only for joint image/text signature field. Allowed values are: LEFT - Align the text to left RIGHT - Align the text to right CENTER - Center the text	LEFT	NO	YES
VISIBLE_SIGNATURE_ SIGNER_TEXT_VERTICAL_ALIGNMENT	Specifies a vertical alignment of a text block with respect to a signature field area. Applicable only for joint image/text signature field. Allowed values are: MIDDLE - Align the text with the center of the picture TOP - Align the text with the top of the picture BOTTOM - Align the text with the bottom of the picture	MIDDLE	NO	YES
VISIBLE_SIGNATURE_ FONT_BASE64	Sets the custom font for the text in the signature field from Base64 encoded custom data.	NONE	NO	YES
VISIBLE_SIGNATURE_ FONT_PATH	Sets the custom font for the text in the signature field from path.	NONE	NO	YES