nestjs / azure-storage

Azure Storage module for Nest framework (node.js) ☁️
https://nestjs.com
MIT License
87 stars 35 forks source link

Validate the SAS key format #9

Closed manekinekko closed 5 years ago

manekinekko commented 5 years ago

I'm submitting a...


[ ] Regression 
[ ] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Users can provide a SAS key when requested to. They might enter a key/token that is not of a SAS format.

Expected behavior

If the user provides a key that is not a SAS, we need to guide them (via a link) to the correct docs so they can create and then use a valid SAS key.

What is the motivation / use case for changing the behavior?

The SAS key might be confusing for developers who are not familiar with Azure. This module uses a SAS key to access the user's storage instance on Azure. People might consider using other types of keys, such as a connection string. But we do require a SAS key as of this version of the module.