Azure Bot Framework secret key

  • Article

Tip

If you're not an E5 customer, use the 90-day Microsoft Purview solutions trial to explore how additional Purview capabilities can help your organization manage data security and compliance needs. Start now at the Microsoft Purview compliance portal trials hub. Learn details about signing up and trial terms.

This SIT is also included in the All credentials bundled SIT.

Format

A combination of 55 characters consisting of letters, digits, and special characters.

or

A combination of 63 characters consisting of letters, digits, and special characters.

Pattern

A combination of 55 characters:

  • a-z (not case-sensitive)
  • 0-9
  • underlines (_)
  • or dots (.)

abcdefghijklmnopqrstuvwxyz.0123456789_ABCDEabcdefghijkl

or for the 63 characters

A combination of 11 characters:

  • a-z (not case-sensitive)
  • 0-9
  • dashes (-)
  • or underlines (_)
  • a dot

A combination of three characters:

  • a-z (not case-sensitive)
  • 0-9
  • dashes (-)
  • or underlines (_)
  • a dot

A combination of three characters:

  • a-z (not case-sensitive)
  • 0-9
  • dashes (-)
  • or underlines (_)
  • a dot

A combination of 43 characters

  • a-z (not case-sensitive)
  • 0-9
  • dashes (-)
  • or underlines (_)

for example:

abcdefghijk.lmn.opq.rstuvwxyz0123456789-_ABCDEFGHIJKLMNOPQRSTUV

Credential example

host: webchat.botframework.com/?s=abcdefghijklmnopqrstuvwxyz.0123456789_ABCDEabcdefghijkl&

Checksum

No

SITs that have checksums use a unique calculation to check if the information is valid. This means when the Checksum value is Yes, the service can make a positive detection based on the sensitive data alone. When the Checksum value is No additional (secondary) elements must also be detected for the service to make a positive detection.

Keyword Highlighting

Supported

When keyword highlighting is supported in the contextual summary for a sensitive information type or a trainable classifier, in the Contextual Summary view of activity explorer, the keywords in a document that were matched to a policy are highlighted.

Definition

This SIT is designed to match the security information that's used to connect to WebChat channels from Azure Bot services.

It uses several primary resources:

  • Patterns of Base64 URL encoded 328-bits symmetric key.
  • Patterns of Base64 URL encoded 360-bits symmetric key.
  • Patterns of CredentialName, CredentialFeatures, AccountIdentityName, AccountIdentityValue, ResourceType, ResourceName.
  • Patterns of mockup values, redactions, and placeholders.
  • A dictionary of vocabulary.

The patterns are designed to match actual credentials with reasonable confidence. The patterns don't match credentials formatted as examples. Mockup values, redacted values, and placeholders, like credential type or usage descriptions, in the position where an actual secret value should present won't be matched.

Keywords

Keyword_SymmetricKey328Url:

  • botframework
  • key

Keyword_SymmetricKey360Url:

  • botframework
  • key