Newlywed Party Monsters

    @azure/cosmos-sign
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    cosmos-sign

    latest npm badge CircleCI npm bundle size (minified + gzip)

    Utility library for signing Azure Cosmos tokens and generating headers. Works in both node and the browser

    npm install cosmos-sign

    Generate a signed header value using your master key

    import { generateSignature } from "cosmos-sign"
    
    const masterKey = "< your master key here >"
    const method = "GET"
    const resourceId = ""
    const resourceType = ""
    
    const result = generateSignature(masterKey, method, resourceType, resourceId)

    Generate a headers object instead

    import { generateHeaders } from "cosmos-sign"
    
    const masterKey = "< your master key here >"
    const method = "GET"
    const resourceId = ""
    const resourceType = ""
    
    const headers = generateHeaders(masterKey, method, resourceType, resourceId)
    
    fetch("https://your-db.cosmos.azure.com/", {
      headers
    })

    Optionally pass a date in

    import { generateSignature } from "cosmos-sign"
    
    const masterKey = "< your master key here >";
    const method = "GET";
    const resourceId = "";
    const resourceType = "";
    const date = new Date(<tomorrow>)
    
    const result = generateSignature(masterKey, method, resourceType, resourceId, date);

    Notes

    See https://docs.microsoft.com/en-us/rest/api/cosmos-db/access-control-on-cosmosdb-resources for documentation on how to generate signatures

    Contributing

    This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

    When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Keywords

    Install

    npm i @azure/cosmos-sign

    DownloadsWeekly Downloads

    34

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    11.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • azure-sdk