Index | Prev | Next

Common Name Template (platCrypto-CommonNameTemplate)

The Common Name Template component is a type of Certificate Parameter that will generate a dynamic common name for the signed certificate based upon configurable settings. The main benefit of this is the ability to generate a potentially unique common name for each component.

To use the Common Name Template component, drag it from the signingService palette beneath a Signing Profile underneath the Signing Service in a running station.Image

The generated common name will by default resolve the Custom BFormat against the requesting component resulting in a common name matching the component’s parent name.

This can be customized by modifying the Custom value, and by selecting values to prepend or append, or both in the respective Prefix and Suffix drop-downs. The Separator value is used to join the different parts of the common name.

 NOTE: The NiagaraStation Address options for the Prefix, Middle, and Suffix properties (as of Niagara 4.14) will only resolve to the NiagaraStation Address when specified on a profile of the Signing Service, not when added to the remote signing requester. They also will not resolve if used with a local signing requester. In those cases, they will revert to the next fallback option. The reason is that a remote FOX connection is needed through which the Signing Service station that receives the request can locate the corresponding NiagaraStation in its NiagaraNetwork. This is not possible for local signing requesters or when the component is added to a remote station instead of the profile in the Signing Service station. 
Available values for the three different parts of the name are:
  • None — no value and no separator used
  • Value of Format Slot — the value of the BFormat resolved against the requesting component
  • Station Name
  • Device Name — or an empty string if the component is not beneath a device
  • Network Name — or an empty string if the component is not beneath a network
  • Host Name
  • Uid — a 16–character unique string
  • Ip Address
  • Host Name Or Ip Address
  • NiagaraStation Address Or Host Name — This option will first attempt to locate a corresponding NiagaraStation in the NiagaraNetwork of the local station, which is the SigningService station, to find a match for the requester. If located, the Address property value of that NiagaraStation will be used. If not found, it will use the Host Name of the requester.
  • NiagaraStation Address Or Ip Address — This option will first attempt to locate a corresponding NiagaraStation in the NiagaraNetwork of the local station, which is the SigningService station, to find a match for the requester. If located, the Address property value of that NiagaraStation will be used. If not found, it will use the IP Address of the requester.
  • NiagaraStation Address, Host Name, Or Ip Address — This option first will attempt to locate a corresponding NiagaraStation in the NiagaraNetwork of the local station, which is the SigningService station, to find a match for the requester. If located, the Address property value of that NiagaraStation will be used. If not located, it will next attempt to use the Host Name of the requester. If the Host Name is not available, it will use the IP Address of the requester.

Property Value Description
Parameter Type read-only Displays the name of the certificate parameter.
Dn Field read-only CN
Prefix drop-down (defaults to None) Selects the type of value to prepend to the common name. As of Niagara 4.14, the following additional options are available:
  • NiagaraStation Address Or Host Name
  • NiagaraStation Address Or Ip Address
  • NiagaraStation Address, Host Name, Or Ip Address
Middle drop-down (defaults to NiagaraStation Address, Host Name, Or Ip Address) Selects the type of value forming the middle of the common name. As of Niagara 4.14, the following additional options are available:
  • NiagaraStation Address Or Host Name
  • NiagaraStation Address Or Ip Address
  • NiagaraStation Address, Host Name, Or Ip Address
Suffix drop-down (defaults to None) Selects the type of value to append to the common name. As of Niagara 4.14, the following additional options are available:
  • NiagaraStation Address Or Host Name
  • NiagaraStation Address Or Ip Address
  • NiagaraStation Address, Host Name, Or Ip Address
Custom BFormat string Format used to resolve against the requesting component.
Separator string Specifies the value to join the different parts of the common name string.

Related Links

  • Components (Parent Topic)

    • Index | Prev | Next