Skip to content

xms-secret-in-response.md

Latest commit

 

History

History
83 lines (68 loc) · 2.1 KB

xms-secret-in-response.md

File metadata and controls

83 lines (68 loc) · 2.1 KB

XMSSecretInResponse

Category

ARM Error

Applies to

ARM OpenAPI(swagger) specs

Related ARM Guideline Code

  • RPC-Put-V1-13

Description

When defining the response model for an ARM PUT/GET/POST operation, any property that contains sensitive information (such as passwords, keys, tokens, credentials, or other secrets) must include the "x-ms-secret": true annotation. This ensures that secrets are properly identified and handled according to ARM security guidelines.

How to fix the violation

To fix this violation, review the response model for your ARM PUT/GET/POST operation and identify all properties that store secrets (such as password, key, access, credentials, token, secret, auth). For each of these properties, add the "x-ms-secret": true annotation to ensure they are properly marked as secrets. This helps protect sensitive information and complies with ARM guidelines.

Note: The ARM reviewers have determined that the property is a false positive and have verified that it does not contain any secrets, they can suppress the error.

Good example

"Resource": {
  "description": "The resource",
  "properties": {
    "password": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "accessKey": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "key": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "token": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "credentials": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "secret": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    },
    "auth": {
      "type": "string",
      "description": "secret",
      "x-ms-secret": "true"
    }
  }
}

Bad example

"Resource": {
  "description": "The resource",
  "properties": {
    "password": {
      "type": "string",
      "description": "secret"
      // No x-ms-secret annotation
    }
  }
}
⚡