@azure/storage-queue
Version:
Microsoft Azure Storage SDK for JavaScript - Queue
69 lines • 3.69 kB
JavaScript
;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.generateQueueSASQueryParameters = generateQueueSASQueryParameters;
exports.generateQueueSASQueryParametersInternal = generateQueueSASQueryParametersInternal;
const QueueSASPermissions_js_1 = require("./QueueSASPermissions.js");
const SasIPRange_js_1 = require("./SasIPRange.js");
const SASQueryParameters_js_1 = require("./SASQueryParameters.js");
const constants_js_1 = require("./utils/constants.js");
const utils_common_js_1 = require("./utils/utils.common.js");
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn and identifier.
*
* WARNING: When identifier is not provided, permissions and expiresOn are required.
* You MUST assign value to identifier or expiresOn & permissions manually if you initial with
* this constructor.
*
* @param queueSASSignatureValues -
* @param sharedKeyCredential -
*/
function generateQueueSASQueryParameters(queueSASSignatureValues, sharedKeyCredential) {
return generateQueueSASQueryParametersInternal(queueSASSignatureValues, sharedKeyCredential)
.sasQueryParameters;
}
function generateQueueSASQueryParametersInternal(queueSASSignatureValues, sharedKeyCredential) {
if (!queueSASSignatureValues.identifier &&
!(queueSASSignatureValues.permissions && queueSASSignatureValues.expiresOn)) {
throw new RangeError("Must provide 'permissions' and 'expiresOn' for Queue SAS generation when 'identifier' is not provided.");
}
const version = queueSASSignatureValues.version
? queueSASSignatureValues.version
: constants_js_1.SERVICE_VERSION;
let verifiedPermissions;
// Calling parse and toString guarantees the proper ordering and throws on invalid characters.
if (queueSASSignatureValues.permissions) {
verifiedPermissions = QueueSASPermissions_js_1.QueueSASPermissions.parse(queueSASSignatureValues.permissions.toString()).toString();
}
// Signature is generated on the un-url-encoded values.
const stringToSign = [
verifiedPermissions ? verifiedPermissions : "",
queueSASSignatureValues.startsOn
? (0, utils_common_js_1.truncatedISO8061Date)(queueSASSignatureValues.startsOn, false)
: "",
queueSASSignatureValues.expiresOn
? (0, utils_common_js_1.truncatedISO8061Date)(queueSASSignatureValues.expiresOn, false)
: "",
getCanonicalName(sharedKeyCredential.accountName, queueSASSignatureValues.queueName),
queueSASSignatureValues.identifier,
queueSASSignatureValues.ipRange ? (0, SasIPRange_js_1.ipRangeToString)(queueSASSignatureValues.ipRange) : "",
queueSASSignatureValues.protocol ? queueSASSignatureValues.protocol : "",
version,
].join("\n");
const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
return {
sasQueryParameters: new SASQueryParameters_js_1.SASQueryParameters(version, signature, verifiedPermissions, undefined, undefined, queueSASSignatureValues.protocol, queueSASSignatureValues.startsOn, queueSASSignatureValues.expiresOn, queueSASSignatureValues.ipRange, queueSASSignatureValues.identifier),
stringToSign: stringToSign,
};
}
function getCanonicalName(accountName, queueName) {
// Queue: "/queue/account/queueName"
return `/queue/${accountName}/${queueName}`;
}
//# sourceMappingURL=QueueSASSignatureValues.js.map