Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ACL file format for brokers.

 Notes on file formats

  • A line starting with the character '#' will be considered a comment, and will be ignored.
  • Since the '#' char (and others that are commonly used for comments) are commonly found in routing keys and other AMQP literals, it is simpler (for now) to hold off on allowing trailing comments (ie comments in which everything following a '#' is considered a comment). This could be reviewed later once the rest of the format is firmed upFile order - first match top to bottom.
  • Group lists may be extended to the following line by terminating the line with the '\' character. However, this may only occur after the group name or any of the names following the group name. Empty extension lines (ie just a '\' character) are not permitted.
    Code Block
    
    # Examples of extending group lists using a trailing '\' character
    
    group group1 name1 name2 \
                 name3 name4 \
                 name 5
    
    group group2 \
                 group1 \
                 name6
    
    # The following are illegal:
    
    # '\' must be after group name
    group \
          group3 name7 name8
    
    # No empty extension lines
    group group4 name9 \
                       \
                 name10
    
  • All permission rules are limited to a single line.
  • Rules are interpreted from the top of the file down until the name match is obtained; at which point processing stops.
  • The last line of the file (whether present or not) will be "acl deny"
  • Group names may contain only a-z, A-Z, 0-9, '-','_'.
  • A line starting with the character '#' will be considered a comment, and will be ignored.
  • Since the '#' char (and others that are commonly used for comments) are commonly found in routing keys and other AMQP literals, it is simpler (for now) to hold off on allowing trailing comments (ie comments in which everything following a '#' is considered a comment). This could be reviewed later once the rest of the format is firmed up.
  • Rules must be preceded by any group definitions they may use; any name not previously defined as a group will be assumed to be that of an individual.

...