managed_identity_credential.hpp

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include <azure/core/credentials/credentials.hpp>
#include <azure/core/credentials/token_credential_options.hpp>
#include <azure/core/resource_identifier.hpp>
 
#include <memory>
#include <string>
#include <utility>
 
#if defined(_azure_TESTING_BUILD)
// Define the class used from tests
namespace Azure { namespace Identity { namespace Test {
  class ManagedIdentityId_Basic_Test;
  class ManagedIdentityId_Invalid_Test;
}}} // namespace Azure::Identity::Test
#endif
 
namespace Azure { namespace Identity {
  namespace _detail {
    class ManagedIdentitySource;
 
    enum class ManagedIdentityIdKind
    {
      SystemAssigned,
      ClientId,
      ObjectId,
      ResourceId,
    };
  } // namespace _detail
 
  class ManagedIdentityId final {
    friend class ManagedIdentityCredential;
#if defined(_azure_TESTING_BUILD)
    // make tests classes friends to validate ManagedIdentityId behavior
    friend class Azure::Identity::Test::ManagedIdentityId_Basic_Test;
    friend class Azure::Identity::Test::ManagedIdentityId_Invalid_Test;
#endif
 
  private:
    _detail::ManagedIdentityIdKind m_idKind;
    std::string m_id;
 
  public:
    explicit ManagedIdentityId() : m_idKind(_detail::ManagedIdentityIdKind::SystemAssigned) {}
 
    static ManagedIdentityId SystemAssigned() { return ManagedIdentityId(); }
 
    static ManagedIdentityId FromUserAssignedClientId(std::string id)
    {
      return ManagedIdentityId(_detail::ManagedIdentityIdKind::ClientId, std::move(id));
    }
 
    static ManagedIdentityId FromUserAssignedObjectId(std::string id)
    {
      return ManagedIdentityId(_detail::ManagedIdentityIdKind::ObjectId, std::move(id));
    }
 
    static ManagedIdentityId FromUserAssignedResourceId(Azure::Core::ResourceIdentifier const& id)
    {
      return ManagedIdentityId(_detail::ManagedIdentityIdKind::ResourceId, id.ToString());
    }
 
  private:
    explicit ManagedIdentityId(_detail::ManagedIdentityIdKind idKind, std::string id)
        : m_idKind(idKind), m_id(std::move(id))
    {
      if (idKind == _detail::ManagedIdentityIdKind::SystemAssigned && !m_id.empty())
      {
        throw std::invalid_argument(
            "There is no need to provide an ID (such as client, object, or resource ID) if you are "
            "using system-assigned managed identity.");
      }
 
      if (m_id.empty()
          && (idKind == _detail::ManagedIdentityIdKind::ClientId
              || idKind == _detail::ManagedIdentityIdKind::ObjectId
              || idKind == _detail::ManagedIdentityIdKind::ResourceId))
      {
        throw std::invalid_argument(
            "Provide the value of the client, object, or resource ID corresponding to the "
            "ManagedIdentityIdKind specified. The provided ID should not be empty in the case of "
            "user-assigned managed identity.");
      }
    }
 
    std::string const& GetId() const { return m_id; }
 
    _detail::ManagedIdentityIdKind GetManagedIdentityIdKind() const { return m_idKind; }
  };
 
  struct ManagedIdentityCredentialOptions final : public Core::Credentials::TokenCredentialOptions
  {
    ManagedIdentityId IdentityId;
  };
 
  class ManagedIdentityCredential final : public Core::Credentials::TokenCredential {
  private:
    std::unique_ptr<_detail::ManagedIdentitySource> m_managedIdentitySource;
 
  public:
    ~ManagedIdentityCredential() override;
 
    explicit ManagedIdentityCredential(
        std::string const& clientId = std::string(),
        Azure::Core::Credentials::TokenCredentialOptions const& options
        = Azure::Core::Credentials::TokenCredentialOptions());
 
    explicit ManagedIdentityCredential(
        Azure::Identity::ManagedIdentityCredentialOptions const& options);
 
    explicit ManagedIdentityCredential(
        Azure::Core::Credentials::TokenCredentialOptions const& options);
 
    Core::Credentials::AccessToken GetToken(
        Core::Credentials::TokenRequestContext const& tokenRequestContext,
        Core::Context const& context) const override;
  };
 
}} // namespace Azure::Identity