blob_sas_builder.hpp

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/storage/blobs/blob_responses.hpp"
 
#include <azure/storage/common/account_sas_builder.hpp>
 
#include <string>
 
namespace Azure { namespace Storage { namespace Sas {
 
  enum class BlobSasResource
  {
    BlobContainer,
 
    Blob,
 
    BlobSnapshot,
 
    BlobVersion,
  };
 
  enum class BlobContainerSasPermissions
  {
    Read = 1,
 
    Write = 2,
 
    Delete = 4,
 
    List = 8,
 
    Add = 16,
 
    Create = 32,
 
    Tags = 64,
 
    DeleteVersion = 128,
 
    SetImmutabilityPolicy = 256,
 
    PermanentDelete = 512,
 
    All = ~0,
  };
 
  inline BlobContainerSasPermissions operator|(
      BlobContainerSasPermissions lhs,
      BlobContainerSasPermissions rhs)
  {
    using type = std::underlying_type_t<BlobContainerSasPermissions>;
    return static_cast<BlobContainerSasPermissions>(
        static_cast<type>(lhs) | static_cast<type>(rhs));
  }
 
  inline BlobContainerSasPermissions operator&(
      BlobContainerSasPermissions lhs,
      BlobContainerSasPermissions rhs)
  {
    using type = std::underlying_type_t<BlobContainerSasPermissions>;
    return static_cast<BlobContainerSasPermissions>(
        static_cast<type>(lhs) & static_cast<type>(rhs));
  }
 
  enum class BlobSasPermissions
  {
    Read = 1,
 
    Write = 2,
 
    Delete = 4,
 
    Add = 8,
 
    Create = 16,
 
    Tags = 32,
 
    DeleteVersion = 64,
 
    SetImmutabilityPolicy = 128,
 
    PermanentDelete = 256,
 
    All = ~0,
  };
 
  inline BlobSasPermissions operator|(BlobSasPermissions lhs, BlobSasPermissions rhs)
  {
    using type = std::underlying_type_t<BlobSasPermissions>;
    return static_cast<BlobSasPermissions>(static_cast<type>(lhs) | static_cast<type>(rhs));
  }
 
  inline BlobSasPermissions operator&(BlobSasPermissions lhs, BlobSasPermissions rhs)
  {
    using type = std::underlying_type_t<BlobSasPermissions>;
    return static_cast<BlobSasPermissions>(static_cast<type>(lhs) & static_cast<type>(rhs));
  }
 
  struct BlobSasBuilder final
  {
    SasProtocol Protocol;
 
    Azure::Nullable<Azure::DateTime> StartsOn;
 
    Azure::DateTime ExpiresOn;
 
    Azure::Nullable<std::string> IPRange;
 
    std::string Identifier;
 
    std::string BlobContainerName;
 
    std::string BlobName;
 
    std::string Snapshot;
 
    std::string BlobVersionId;
 
    BlobSasResource Resource;
 
    std::string CacheControl;
 
    std::string ContentDisposition;
 
    std::string ContentEncoding;
 
    std::string ContentLanguage;
 
    std::string ContentType;
 
    std::string EncryptionScope;
 
    void SetPermissions(BlobContainerSasPermissions permissions);
 
    void SetPermissions(BlobSasPermissions permissions);
 
    void SetPermissions(std::string rawPermissions) { Permissions = std::move(rawPermissions); }
 
    std::string GenerateSasToken(const StorageSharedKeyCredential& credential);
 
    std::string GenerateSasToken(
        const Blobs::Models::UserDelegationKey& userDelegationKey,
        const std::string& accountName);
 
    std::string GenerateSasStringToSign(const StorageSharedKeyCredential& credential);
 
    std::string GenerateSasStringToSign(
        const Blobs::Models::UserDelegationKey& userDelegationKey,
        const std::string& accountName);
 
  private:
    std::string Permissions;
  };
 
}}} // namespace Azure::Storage::Sas