NAME

OpenXPKI::Server::API2::Plugin::Profile::render_templates

COMMANDS

render_subject_from_template

Renders the certificate subject by using the text template as defined in the certificate profile ("profile.XXX.style.XXX.subject.dn") and the given variables.

The result might be empty.

Parameters

"profile" Str - certificate profile, required
"style" Str - profile substyle, default: first style found in profile
"vars" HashRef - variables to be inserted into (i.e. required by) the template text, required

render_san_from_template

Renders a list of SANs by using the text template as defined in the certificate profile ("profile.XXX.style.XXX.subject.san") and the given variables.

The result is formatted for use with the crypto backend and might be undef if nothing is found.

If additional SANs are specified they are merged with the results of the template parser, duplicates are removed. Expected hash format (empty refs are ok):

    { DNS => [ 'www.example.com', 'www.example.org' ] }

Configuration example:

  subject:
    san:
      dns:
      - "[% hostname %]"
      - "[% FOREACH entry = hostname2 %][% entry %]|[% END %]"
      email: [% email %]

Parameters

"profile" (Str) - certificate profile, required
"style" (Str) - profile substyle, default: first style found in profile
"vars" (HashRef) - variables to be inserted into (i.e. required by) the template text, required
"additional" (HashRef) - additional SANs, default: none

render_metadata_from_template

Renders a HashRef metadata entries by using the text template as defined in the certificate profile ("profile.XXX.style.XXX.metadata") and the given variables.

The return HashRef's values are either scalars (single metadata item) or ArrayRefs (metadata lists, separated by pipe "|" in config). Empty template parsing results are not stored.

Configuration example:

  metadata:
      requestor: "[% requestor_gname %] [% requestor_name %]"

Parameters

"profile" (Str) - certificate profile, required
"style" (Str) - profile substyle, default: first style found in profile
"vars" (HashRef) - variables to be inserted into (i.e. required by) the template text, required

METHODS

process_template

Process the given text template via "process" in Template using the given variables.

Parameters

$template (Str) - text template for TT
$vars (HashRef) - variables for TT

cleanup_for_tt

Cleans up the given HashRef of variables for use in Template Toolkit.

This modifies the argument HashRef!

Parameters

•: $vars (HashRef) - variables for TT