OpenXPKI::Template::Plugin::Metadata

Plugin for Template::Toolkit to retrieve metadata via the config layer. The plugin can access any value below the metadata node in the realm.

How to use

You need to load the plugin into your template before using it. As we do not export the methods, you need to address them with the plugin name, e.g.

    [% USE Metadata %]
    [% Metadata.get(prefix, value, suffix) %]

get(prefix, value, suffix)

Read a scalar value from the config layer at "metadata.prefix.value.suffix".

If prefix contain dots it is considered to be a connector path. Value is taken as single path item which can contain dots and can also be empty.

Suffix is optional, if set the call to prefix.value is done using get_hash and suffix must be the name of a key returned by this call.

get(prefix, value)

Calls get_hash from the config layer at "metadata.prefix.value".

If prefix contain dots it is considered to be a connector path. Value is taken as single path item which can contain dots and can also be empty.

creator(userid)

Split the given userid into namespace and user and call auth.creator.namespace.userid which will display the verbose name of the userid in the namespace.

If the userid does not contain a namespace or no username can be resolved, the method will return undef.

For items in the reserved namespaces the plugin method returns default values in case the node auth.creator.namespace does not exist. The namespace certid returns the full subject of the certificate, in system the literal name is returned.