aherman
/
boundary
mirror of https://github.com/hashicorp/boundary
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b6d58d0c42'
${ noResults }
boundary/internal/classification-rubric.md

1.4 KiB
Raw Blame History

Classification Rubric

This is an initial set of guidelines to use when deciding on the classification of fields for API/SDK resources. The classification is used when generating audit events and will impact the content of the events.

Fields can be classified as secret, sensitive, or public. If a field is not classified, it is treated as secret. The classification is used by the filters/encrypt library along with a configurable filter operation. By default fields classified as secret will be redacted, fields classified as sensitive will be encrypted, and fields classified as public will be left un-modified. See the filters/encrypt package for more details.

  • secret: This classification should be used for any field that contains information like tokens, keys, passwords.
  • sensitive: This classification should be used for any field that contains information like personally identifiable information (PII), such as names of people, email addresses, etc.
  • public: This classification should be use for any field that is not sensitive or secret.

Tag @jimlambrt and @jefferai in your PR if you are unsure about how to classify a field.