URIValidator.inAzureKeyVaultDomain Method

Use Case

The code is making requests to a URL constructed using untrusted inputs, where an input is considered untrusted if it comes from user input or other services.

AND

The URL is expected to belong to an Azure Key Vault Domain.

• If you instead expect the domain to be in any domain or an untrusted domain, see AntiSSRFPolicy.
• If you instead expect the URL to be an Azure Storage endpoint, see inAzureStorageDomain.
• If you instead expect the domain to be another specific, trusted domain, see inDomain.

Definition

Validates if a URL is an Azure Key Vault endpoint.

inAzureKeyVaultDomain(url: URL | string): boolean

Parameters

url: URL | string

The URL to be evaluated.

Returns

• true if url belongs to any of the listed Azure Key Vault domains.
• false if url does not belong to any of the listed Azure Key Vault domains, the url is not a valid URL, or the protocol is not HTTP/S.

Examples

const { URIValidator } = require('@microsoft/antissrf');

URIValidator.inAzureKeyVaultDomain('https://myvault.vault.azure.net/secrets/api-key');
// → true

URIValidator.inAzureKeyVaultDomain('https://evil.com/secrets');
// → false

Azure Key Vault Domain Names

inAzureKeyVaultDomain will evaluate whether the given parameter belongs to any of the following domains:

• vault.azure.net
• managedhsm.azure.net
• vault.azure.cn
• managedhsm.azure.cn
• vault.usgovcloudapi.net
• managedhsm.usgovcloudapi.net