Blob Storage and Shared Access Signatures

I am working on a project where we are uploading client files to Azure Blob Storage.  Blob storage is perfect for this type of application and uploading them with public access is the default behavior.  Therefore any anonymous client can read blob data out of your container.  This doesn’t work so well for this situation.  Luckily there is the Shared Access Signature feature. 

The Shared Access Signature feature provides a means for you to provide permissions, policies and a time window for those permissions and policies to be valid.  You can also modify or revoke the permissions as necessary.  This is important because Azure storage works by providing a password for your storage account.  Anyone who has that password has access/ownership of your storage account.  That is why you can’t give out your shared key.  The only exception to this is of course if you mark your container public.  The Shared Access Signature features allows you to give permissions but still keep control over security.

So, the Shared Access Signatures provides code that lets us separate the code that signs the request from the execution.  It is implemented as a query string parameter that proves that the creator of the URL is authorized to perform the operations.   The following MSDN article shows how to manually create the signature string.  This is here just so that you can see what is provided and how the string is make up.  In addition, there is another MSDN article that shows how to create a shared access signature and provides the following graphic to show the part that make up the query string.

 

 

How can we code the blob access (upload and download) to include the Shared Access Signature? 

The following code shows how to upload a file to blob storage using a Shared Access Signature:

         public string UploadBlobToAzure(string fileName)
        {
            if (fileName == null)
            {
                throw new ArgumentNullException("fileName");
            }

            try
            {
                // create storage account
                string storageConnnectString = string.Format("DefaultEndpointsProtocol={0}; AccountName={1}; 
                       AccountKey={2}", "http", ConfigurationManager.AppSettings["storageAccountName"], 
                       ConfigurationManager.AppSettings["storageAccountKey"]);
                var account = CloudStorageAccount.Parse(storageConnnectString);
               
                // create blob client
                CloudBlobClient blobStorage = account.CreateCloudBlobClient();
                
                //Get the container.  This is what we will attach the signature to.
                CloudBlobContainer container = blobStorage.GetContainerReference("<storagecontainername>");
                container.CreateIfNotExist();

                //Create the shared access permissions and policy
                BlobContainerPermissions containerPermissions = new BlobContainerPermissions();
                string sas = container.GetSharedAccessSignature(new SharedAccessPolicy()
                    {
                        SharedAccessExpiryTime = DateTime.UtcNow.AddMinutes(30), Permissions = 
                            SharedAccessPermissions.Write | SharedAccessPermissions.Read
                    });
                //Turn off public access
                containerPermissions.PublicAccess = BlobContainerPublicAccessType.Off;
                container.SetPermissions(containerPermissions);

                string uniqueBlobName = string.Format(@"<storagecontainername>/<filename>_{0}.config", 
                       Guid.NewGuid().ToString());

                //assign the shared access policy
                CloudBlobClient blobClient = new CloudBlobClient(account.BlobEndpoint, new 
                       StorageCredentialsSharedAccessSignature(sas));

                CloudBlob blb = blobClient.GetBlobReference(uniqueBlobName);

                //upload the file
                blb.UploadFile(fileName);

                System.Console.WriteLine("File successfully uploaded to " + blb.Uri);
                return "File successfully uploaded to " + blb.Uri;
            }
            catch (StorageClientException e)
            {
                return "Blob Storage error encountered: " + e.Message;
            }
            catch (Exception e)
            {
                return "Error encountered: " + e.Message;
            }
            finally
            {
            }
        }

 

Once you upload the file then you can use the following code to access that file and download it locally:

         public string DownloadBlobfromAzure(string fileName)
        {
            if (fileName == null)
            {
                throw new ArgumentNullException("fileName");
            }

            try
            {
                // create storage account
                string storageConnnectString = string.Format("DefaultEndpointsProtocol={0}; AccountName={1}; 
                          AccountKey={2}", "http", ConfigurationManager.AppSettings["storageAccountName"], 
                          ConfigurationManager.AppSettings["storageAccountKey"]);
                var account = CloudStorageAccount.Parse(storageConnnectString);;
                // create blob client
                CloudBlobClient blobStorage = account.CreateCloudBlobClient();

                CloudBlobContainer container = blobStorage.GetContainerReference("<storagecontainername>");
                container.CreateIfNotExist();

                //Create the shared access permission and policy
                BlobContainerPermissions containerPermissions = new BlobContainerPermissions();
                string sas = container.GetSharedAccessSignature(new SharedAccessPolicy()
                {
                    SharedAccessExpiryTime = DateTime.UtcNow.AddMinutes(30),
                    Permissions = SharedAccessPermissions.Write | SharedAccessPermissions.Read
                });
                //Turn off public access
                containerPermissions.PublicAccess = BlobContainerPublicAccessType.Off;
                container.SetPermissions(containerPermissions);

                string uniqueBlobName = string.Format(fileName);

                //Assign the shared access policy
                CloudBlobClient blobClient = new CloudBlobClient(account.BlobEndpoint, new 
                      StorageCredentialsSharedAccessSignature(sas));

                //Get a point to the blob object
                CloudBlob blb = blobClient.GetBlobReference(uniqueBlobName);

                string fileLocation = @"C:\Documents\";
                int pos = fileName.IndexOf('/');
                string fname = fileName.Substring(pos + 1, fileName.Length - pos - 1 );

                //Download the blob object
                blb.DownloadToFile(fileLocation + fname);

                System.Console.WriteLine("File successfully downloaded to " + fileLocation + fname);

                return "File successfully downloaded to " + fileLocation + fname;
            }
            catch (StorageClientException e)
            {
                return "Blob Storage error encountered: " + e.Message;
            }
            catch (Exception e)
            {
                return "Error encountered: " + e.Message;
            }
            finally
            {
            }
        }

You may have noticed that when we created the policy we didn’t specify a SharedAccessStartTime attribute.  We can specify a start time that policy will be good for or we can leave it off in which case the policy will go into effect immediately.

NOTE:  The files names are case sensitive.  If you attempt to find a blob and are not using lower case for the file name you will receive a return error

Outer Exception

Server failed to authenticate the request. Make sure the value of Authorization header is formed correctly including the signature.

Inner Exception Message

{"The remote server returned an error: (403) Forbidden."}