The following sections each describe the syntax for a single line of the file.

Adding a principal

Railroad diagram

Backus-Naur form

add principal " principal_name " " password " [ '[' " role " [ , " role " ] ']' ]

Example

add principal "user6" "passw0rd"
add principal "user13" "passw0rd" ["CLIENT", "TOPIC_CONTROL"]

The password is passed in as plain text, but is stored in the system authentication store as a secure hash.

Removing a principal

Railroad diagram

Backus-Naur form

remove principal " principal_name "

Example

remove principal "user25"

Assigning roles to a principal

Railroad diagram

Backus-Naur form

assign roles " principal_name " '[' " role " [ , " role " ] ']'

Example

assign roles "agent77" ["CLIENT", "CLIENT_CONTROL"]

When you use this command to assign roles to a principal, it overwrites any existing roles assigned to that principal. Ensure that all the roles you want the principal to have are listed in the command.

Setting the password for a principal

Railroad diagram

Backus-Naur form

set password " principal_name " " password "

Example

set password "user1" "passw0rd"

The password is passed in as plain text, but is stored in the system authentication store as a secure hash.

Verifying the password for a principal

Railroad diagram

Backus-Naur form

verify password " principal_name " " password "

Example

verify password "user1" "passw0rd"

The password is passed in as plain text, but is stored in the system authentication store as a secure hash.

Allowing anonymous connections

Railroad diagram

Backus-Naur form

allow anonymous connections [ '[' " role " [ , " role " ] ']' ]

Example

allow anonymous connections [ "CLIENT" ]

Denying anonymous connections

Railroad diagram

Backus-Naur form

deny anonymous connections

Example

deny anonymous connections

Abstaining from providing a decision about anonymous connections

Railroad diagram

Backus-Naur form

abstain anonymous connections

Example

abstain anonymous connections