credentials.hpp

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/core/context.hpp"
#include "azure/core/datetime.hpp"
 
#include <exception>
#include <memory>
#include <mutex>
#include <string>
#include <utility>
#include <vector>
 
namespace Azure { namespace Core { namespace Credentials {
 
  struct AccessToken final
  {
    std::string Token;
 
    DateTime ExpiresOn;
  };
 
  struct TokenRequestContext final
  {
    std::vector<std::string> Scopes;
 
    DateTime::duration MinimumExpiration = std::chrono::minutes(2);
 
    std::string TenantId;
  };
 
  class TokenCredential {
  private:
    std::string m_credentialName;
 
  public:
    virtual AccessToken GetToken(
        TokenRequestContext const& tokenRequestContext,
        Context const& context) const = 0;
 
    std::string const& GetCredentialName() const { return m_credentialName; }
 
    virtual ~TokenCredential() = default;
 
  protected:
    TokenCredential(std::string const& credentialName)
        : m_credentialName(credentialName.empty() ? "Custom Credential" : credentialName)
    {
    }
 
    [[deprecated("Use the constructor with parameter.")]] TokenCredential()
        : TokenCredential(std::string{})
    {
    }
 
  private:
    TokenCredential(TokenCredential const&) = delete;
 
    void operator=(TokenCredential const&) = delete;
  };
 
  class AuthenticationException final : public std::exception {
    std::string m_what;
 
  public:
    explicit AuthenticationException(std::string what) : m_what(std::move(what)) {}
 
    char const* what() const noexcept override { return m_what.c_str(); }
  };
}}} // namespace Azure::Core::Credentials