Skip to content

Configuration

Bundle Configuration

Created via ./bin/console config:dump-reference DbpRelayEsignBundle | sed '/^$/d'

# Default configuration for "DbpRelayEsignBundle"
dbp_relay_esign:
    qualified_signature:
        # The URL to the PDF-AS server for qualified signatures
        server_url:           ~ # Example: 'https://pdfas.example.com/pdf-as-web'
        profiles:
            # Prototype
            -
                # The name of the profile, this needs to be passed to the API
                name:                 ~ # Example: myprofile
                # The Symfony role required to use this profile
                role:                 ~ # Example: ROLE_FOOBAR
                # The PDF-AS signature profile ID to use
                profile_id:           ~ # Example: MYPROFILE
                # The profile table ID to attach the content to. Leave empty to disable user text.
                user_text_table:      ~ # Example: usercontent
                # The index of the first unset row in the table (starts with 1)
                user_text_row:        ~ # Example: 1
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_parent: ~ # Example: parent
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_child: ~ # Example: child
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_row: ~ # Example: 4
    advanced_signature:
        # The URL to the PDF-AS server for advanced signatures
        server_url:           ~ # Example: 'https://pdfas.example.com/pdf-as-web'
        profiles:
            # Prototype
            -
                # The name of the profile, this needs to be passed to the API
                name:                 ~ # Example: myprofile
                # The Symfony role required to use this profile
                role:                 ~ # Example: ROLE_FOOBAR
                # The PDF-AS signature key ID used for singing
                key_id:               ~ # Example: MYKEY
                # The PDF-AS signature profile ID to use
                profile_id:           ~ # Example: MYPROFILE
                # The profile table ID to attach the content to. Leave empty to disable user text.
                user_text_table:      ~ # Example: usercontent
                # The index of the first unset row in the table (starts with 1)
                user_text_row:        ~ # Example: 1
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_parent: ~ # Example: parent
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_child: ~ # Example: child
                # In case there is content "child" will be attached to "parent" at "row" (optional)
                user_text_attach_row: ~ # Example: 4

Examples

dbp_relay_esign:
  qualified_signature:
    server_url: 'https://sig.tugraz.at/pdf-as-web'
    profiles:
      name: default
      profile_id: 'SIGNATURBLOCK_SMALL_DE_NOTE_PDFA'

dbp_relay_esign:
  advanced_signature:
    server_url: 'https://pdfas.tugraz.at/pdf-as-web'
    profiles:
      - name: official
        key_id: tugraz-official
        profile_id: SIGNATURBLOCK_TUGRAZ_AMTSSIGNATUR
        role: ROLE_SCOPE_OFFICIAL-SIGNATURE
      - name: sap
        key_id: tugraz-sap
        profile_id: SIGNATURBLOCK_TUGRAZ_SAP
        role: ROLE_SCOPE_CORPORATE-SIGNATURE

User Defined Text

This allows the user of the API to append custom rows to a table in the visible signature block.

Both qualified_profile as well as every entry in advanced_profiles allows setting an optional user text configuration:

user_text_table: user user_text_row: 1 user_text_attach_parent: info user_text_attach_child: user user_text_attach_row: 2

  • user_text_table - The profile table ID to attach the content to
  • user_text_row - The index of the first unset row in the table (starts with 1)
  • user_text_attach_parent/user_text_attach_child/user_text_attach_row (optional) - In case there is content to add the child will be attached to parent at row row.

The extra attachment configuration is required because pdf-as-web doesn't allow reachable empty tables, so we either have to add to existing tables or attach a new table depending on wether we want to add rows or not. Example:

# We attach user text rows to "user" at row 1
# and if there are any rows we attach "user" to "info" at row 2
user_text_table: user
user_text_row: 1
user_text_attach_parent: info
user_text_attach_child: user
user_text_attach_row: 2

To allow the esign bundle to add custom text to the signature profiles you need to whitelist these configuration objects in the pdf-as-web.properties file of pdf-as-web:

allow.ext.overwrite=true
ext.overwrite.wl.01=^sig_obj\\.SIGNATURBLOCK_TUGRAZ_AMTSSIGNATUR\\..*$
ext.overwrite.wl.02=^sig_obj\\.SIGNATURBLOCK_TUGRAZ_SAP\\..*$

Note that this allows changing everything regarding the signature profile, so make sure the SOAP API isn't publicly reachable.

PDF-AS Configuration

It's recommended to have two separate pdf-as servers for the advanced and qualified signatures because the advanced signature one can not be public while the qualified one needs to be accessible from the internet for talking with handy-signatur.at

Qualified Server

FIXME: other unrelated required options

Advanced Server

FIXME: other unrelated required options

The pdf-as-web service needs to be configured in pdf-as-web.properties to contain a keystore list containing the keys referenced in the bundle config file.

# Local key store list
ksl.tugraz-official.enabled=true
ksl.tugraz-official.file=/path/to/tomcat/conf/pdf-as/my-pdf-cert.p12
ksl.tugraz-official.type=PKCS12
ksl.tugraz-official.pass=keystore-password
ksl.tugraz-official.key.alias=mycert
ksl.tugraz-official.key.pass=cert-password

In addition, in the pdf-as configuration (config.properties) the referenced profiles need to be defined. Usually they are defined in extra files under ./profiles and then included in config.properties:

include.01 = profiles/SIGNATURBLOCK_TUGRAZ_AMTSSIGNATUR.properties
include.02 = profiles/SIGNATURBLOCK_TUGRAZ_SAP.properties

The signature property files included need to use the profile key referenced in the bundle config:

...
sig_obj.SIGNATURBLOCK_TUGRAZ_AMTSSIGNATUR = ...
...