Banners

There are two kind of banners, the pre-authentication banner is shown before the user logs in to the CipherTrust Manager server, and the post-authentication banner is shown after login. Both are optional and not set by default.

The pre-authentication banner is useful for displaying disclaimer or legal security policy. You must accept the terms identified in this banner in order to login. Not accepting the terms will prevent you from logging in to the CipherTrust Manager server.

The post-authentication banner is useful for displaying information about the system. This banner message can be used to provide general information about the server to the user such as upcoming maintenance. The user is not asked to accept this banner message.

You can view and update the banner pages using the CLI, GUI and API.

Banners support the unicode standard and the Markdown markup language.

Viewing the Banners using the ksctl CLI

Using the CLI, any authenticated user in any domain can view the pre- and post-authentication banner by using the banners get command:

Example get commands:

$ ksctl banners get --name pre-auth

or

$ ksctl banners get --name post-auth

Default command response before updating the banner message, for each command is:

{
  "value": ""
}

Example response after updating the pre- or post authentication banner:

{
  "value": "Example text of the banner."
}

Updating the Banners using the ksctl CLI

This action requires you to login to the root domain as a user in the admingroup, such as admin.

You can update the pre- and post-authentication banners using the banners update command:

There are two ways to provide a new banner message:

• using the argument --message <banner-message> where <banner-message> is new banner message

• using the argument --file <banner-message-file>, where <banner-message-file> is a path and filename in Markdown notation containing the new banner message

  Example: /path/banner-message.md

Pre-auth Example update --message command:

$ ksctl banners update --name pre-auth --message "Before logging in to CipherTrust Manager, you must accept the following 'Terms of Use': ..."

Response:

{
  "value": "Before logging in to CipherTrust Manager, you must accept the following 'Terms of Use': ..."
}

Post-auth Example update --message command:

$ ksctl banners update --name post-auth --message "Welcome to **CipherTrust k170v Server**."

Response:

{
  "value": "Welcome to **CipherTrust k170v Server**."
}

Pre-auth Example update --file command:

$ ksctl banners update --name pre-auth --file </path/banner-message.md>

If the markdown file contains: "Before logging in to CipherTrust Manager, you must accept the following 'Terms of Use': ...", the response is:

{
  "value": "Before logging in to CipherTrust Manager, you must accept the following 'Terms of Use': ..."
}

Post-auth Example update --file command:

$ ksctl banners update --name post-auth --file </path/banner-message.md>

If the markdown file contains: "Welcome to **CipherTrust k170v Server**.", the response is:

{
  "value": "Welcome to **CipherTrust k170v Server**."
}

Updating the Banners Using the CipherTrust Web UI

1. Log in to the root domain as a user in the admingroup, such as admin.

2. Navigate to Admin Settings > Login Banners.

3. Select the Pre Authentication or Post Authentication depending on the desired banner type.

4. In the left text box, type the banner message.

5. Format the message as desired. You can use markdown syntax directly, or the editing icons to format your message. The right text box renders the formatted message, allowing you to preview the banner appearance.

   The formatting icons are as follows:

   

   • 1 - Insert a heading.

   • 2 - Format the selected text in bold.

   • 3 - Format the selected text in italics.

   • 4 - Format the selected text in underline.

   • 5 - Format the selected text in strikethrough.

   • 6 - Insert a bulleted list.

   • 7 - Insert a numbered list.

   • 8 - Format the selected text as a blockquote.

   • 9 - Insert a horizontal rule.

   • 10 - Format the selected text formatted as inline code.

   • 11 - Format the selected text as a codeblock.

   • 12 - Insert a table.

   • 13 - Format the selected text as a hyperlink.

1. If necessary, use the delete all (1), undo (2), and redo (3) icons.

   

2. Click Save to save your changes.