ゴキゲンBlog: 5月 2020

「Azure SDK for Go documentation」サイトの「Authentication methods in the Azure SDK for Go」ページを読み進めました。

本セクションでは、Azure SDK for Goを使ってAzureで認証するための形式と方式が紹介されています。

ここでは、対象ページの内容をベースに...というか結果的にGoogle翻訳による日本語翻訳状態となり、私なりの言い回しを加えています。ちなみに、"type"は"形式"に、"method"は"方式"に、日本語訳しています。

利用可能な認証の形式と方式

Azure SDK for Goは複数の資格情報セットと認証形式を提供し、認証形式は複数の認証方式（認証情報をSDKに取り込む操作）で呼び出せます。

提供されている認証形式は、次の通りです。

証明書ベース形式

Azure Active Directory（以降、Azure AD）ユーザーまたはサービスプリンシパル用に構成されたX509証明書を使ってクライアント認証を行います。詳細については「Get started with certificate-based authentication in Azure Active Directory」を参照してください。

クライアント資格情報形式

アプリケーションに構成済みのサービスプリンシパルを組み込んで認証します。詳細については「Create a service principal with Azure CLI」を参照してください。

AzureリソースのマネージドID形式

アプリケーションは、Azure ADが自動的にAzureサービスに提供したマネージドIDを使ってAzure AD認証をサポートするAzureサービスを認証します。詳細は「Managed identities for Azure resources」を参照してください。

デバイストークン形式

多要素認証を有効にしたユーザーのデバイスにトークンを渡し、WebブラウザーでMicrosoftサインインにアクセスしてAzure ADアカウントで認証します。詳細は「Use device token authentication」を参照してください。

ユーザー名/パスワード形式

ユーザー名とパスワードで認証します。多要素認証が無効状態でのAzure ADサインインのため、セキュリティ面で不安があります。

【重要】クライアント資格情報形式以外の認証形式を使用する場合、アプリケーションはAzure ADに登録されている必要があります。詳細は「Integrating applications with Azure Active Directory」を参照してください。

【注意】特別な要件がない限り、ユーザー名/パスワード形式は避けてください。ユーザーベースのサインインが必要な場合はデバイストークン形式で対応してください。

これらの認証形式は、さまざまな認証方式で利用できます。

環境ベース方式

シェルの環境変数から資格情報を読み取ります。

ファイルベース方式

サービスプリンシパルの資格情報などをファイルから読み込みます。

クライアントベース方式

コード内のオブジェクトを使用し、プログラムの実行中に資格情報を提供する必要があります。

デバイストークン方式

ユーザーはトークンを使用してWebブラウザーからインタラクティブにサインインする必要があります。

すべての認証機能と認証方式は、github.com/Azure/go-autorest/autorest/azure/authパッケージで利用できます。

【注意】特別な要件がない限り、クライアントベース方式は避けてください。認証情報をハードコード化する傾向にあり、認証要件が変更された場合のSDKリリースで機能しなくなる可能性があります。

環境ベース方式を使用する

アプリケーションを実行する前にシェルの環境変数を構成し、実行時にこれらの環境変数を読み取り、Azureで認証します。

環境ベース方式は、デバイストークン形式を除くすべての認証形式をサポートしており、次の順序で評価されます。

クライアント資格情報形式
証明書ベース形式
ユーザー名/パスワード形式
AzureリソースのマネージドID形式

認証形式に未設定の値があるか拒否された場合、SDKは自動的に次の認証形式を試行し、形式がなくなるとエラーを返します。

次の表は、環境ベース形式でサポートされる認証形式ごとに設定する必要がある環境変数の詳細を示しています。

クライアント資格情報形式

AZURE_TENANT_ID
      サービスプリンシパルが属するActive DirectoryテナントのID。
AZURE_CLIENT_ID
      サービスプリンシパルの名前またはID。
AZURE_CLIENT_SECRET
      サービスプリンシパルに関連付けられているシークレット。

証明書ベース形式

AZURE_TENANT_ID
      証明書が登録されているActive DirectoryテナントのID。
AZURE_CLIENT_ID
      証明書に関連付けられているアプリケーションクライアントID。
AZURE_CERTIFICATE_PATH
      クライアント証明書ファイルへのパス。
AZURE_CERTIFICATE_PASSWORD
      クライアント証明書のパスワード。

ユーザー名/パスワード形式

AZURE_TENANT_ID
      ユーザーが属するActive DirectoryテナントのID。
AZURE_CLIENT_ID
      アプリケーションクライアントID。
AZURE_USERNAME
      サインインに使用するユーザー名。
AZURE_PASSWORD
      サインインに使用するパスワード。

AzureリソースのマネージドID形式

マネージドID形式に資格情報は必要ありません。
アプリケーションは、マネージドIDを使用するように構成
されたAzureリソースで実行されている必要があります。
詳細については「Managed identities for Azure resources」を
参照してください。

既定のAzureパブリッククラウド以外のクラウドまたは管理エンドポイントに接続するには、次の環境変数を設定します。例えば、Azure Stack、別の地域のクラウド、または従来のデプロイモデルを使用している場合です。

AZURE_ENVIRONMENT
      接続するクラウド環境の名前。
AZURE_AD_RESOURCE
      接続時に使用するActive DirectoryリソースID。
      管理エンドポイントへのURIとして使用します。

Goコードでは、NewAuthorizerFromEnvironment関数を呼び出してオーソライザーオブジェクトを取得します。このオブジェクトは、クライアントのAuthorizerプロパティで設定され、Azureへのアクセスを許可します。

import "github.com/Azure/go-autorest/autorest/azure/auth"
authorizer, err := auth.NewAuthorizerFromEnvironment()

Azure Stackでの認証

Azure Stackで認証するには、次の環境変数を設定する必要があります。

AZURE_AD_ENDPOINT
      Active Directoryエンドポイント。
AZURE_AD_RESOURCE
      Active DirectoryリソースID。

これらの環境変数は、Azure Stackメタデータ情報から取得できます。メタデータを取得するには、Azure Stack環境でWebブラウザーを開き、次のURLを使用します：(ResourceManagerURL)/metadata/endpoints?api-version=1.0

ResourceManagerURLは、Azure Stackデプロイメントのリージョン名、マシン名、および外部の完全修飾ドメイン名（FQDN）によって異なります。

開発キット
      https://management.local.azurestack.external/
統合システム
      https://management.(region).ext-(machine-name).(FQDN)

Azure StackでAzure SDK for Goを使用する方法の詳細については「Use API version profiles with Go in Azure Stack」を参照してください。

ファイルベース方式を使用する

ファイルベース方式では、Azure CLIによって生成されたファイル形式を使用します。--sdk-authパラメータを使用して新しいサービスプリンシパルを作成するときに、このファイルを簡単に作成できます。CLIはstdoutに出力するため、出力をファイルにリダイレクトします。

az ad sp create-for-rbac --sdk-auth > azure.auth

AZURE_AUTH_LOCATION環境変数を、許可ファイルが配置されている場所に設定します。この環境変数はアプリケーションによって読み取られ、その中の資格情報が解析されます。実行時に認証ファイルを選択する必要がある場合は、os.Setenv https://golang.org/pkg/os/#Setenv関数を使用してプログラムの環境を操作します。

認証情報を読み込むには、NewAuthorizerFromFile関数を呼び出します。環境ベース方式とは異なり、ファイルベース方式にはリソースエンドポイントが必要です。

import "github.com/Azure/go-autorest/autorest/azure/auth"
authorizer, err := NewAuthorizerFromFile(azure.PublicCloud.ResourceManagerEndpoint)

サービスプリンシパルの使用とアクセス許可の管理の詳細については「Create a service principal with Azure CLI」を参照してください。

デバイストークン方式を使用する

ユーザーにインタラクティブにサインインさせる場合は、デバイストークン方式が最適です。ユーザーにトークンを渡してMicrosoftサインインサイトに貼り付け、Azure Active Directory（AAD）アカウントで認証します。この認証方式は、標準のユーザー名/パスワード方式とは異なり、多要素認証が有効になっているアカウントをサポートします。

NewDeviceFlowConfig関数を使用してDeviceFlowConfigオーソライザーを作成します。結果のオブジェクトでAuthorizerを呼び出して、認証プロセスを開始します。デバイスフロー認証は、認証フロー全体が完了するまでプログラムの実行をブロックします。

import "github.com/Azure/go-autorest/autorest/azure/auth"
deviceConfig := auth.NewDeviceFlowConfig(applicationID, tenantID)
authorizer, err := deviceConfig.Authorizer()

認証クライアントを使用する

特定の形式の認証が必要で、プログラムがユーザーからの認証情報を読み込んで処理を進める場合は、auth.AuthorizerConfigインターフェースに準拠する任意のクライアントを使用できます。次の場合は、このインターフェースを実装する型を使用します。

インタラクティブなプログラムを書く
専用の構成ファイルを使用する
用意されている認証形式では対応できない要件である

【警告】Azure資格情報をアプリケーションにハードコードしないでください。アプリケーションのバイナリーにシークレットを入れると、アプリケーションが実行されているかどうかにかかわらず、攻撃者がシークレットを簡単に抽出できます。これにより、資格情報が承認されているすべてのAzureリソースが危険にさらされます。

次の表に、AuthorizerConfigインターフェースに準拠するSDKの形式を示します。

証明書ベース形式
      ClientCertificateConfig
クライアント資格情報形式
      ClientCredentialsConfig
AzureリソースのマネージドID形式
      MSIConfig
ユーザー名/パスワード形式
      UsernamePasswordConfig

関連付けられたNew関数を使用してオーセンティケーターを作成し、結果のオブジェクトに対してAuthorizeを呼び出して認証します。たとえば、証明書ベース形式を使用するには次のようになります：

import "github.com/Azure/go-autorest/autorest/azure/auth"
certificateAuthorizer := auth.NewClientCertificateConfig(certificatePath, certificatePassword, clientID, tenantID)
authorizerToken, err := certificateAuthorizer.Authorize()

GoのtimeパッケージのAddDate()関数ですが、例えば10月31日に1ヶ月を足すと11月31日となりDateの正規化によって12月1日になります。

package main

import (
        "fmt"
        "time"
)

func main() {
        t := time.Date(2019, 10, 31, 0, 0, 0, 0, time.Local)
        fmt.Println(t)
        fmt.Println(t.AddDate(0, 1, 0), "(Add 1 month)")
}

実行結果

2019-10-31 00:00:00 +0000 UTC
2019-12-01 00:00:00 +0000 UTC (Add 1 month)

そこで、月末日の時は増減した月の月末日、すなわち、10月31日に1ヶ月を足すと11月30日となる関数「AddMonth()」を考えてみました。（注意：横スクロールしてください）

Go Playgound へ

package main

import (
        "fmt"
        "time"
)

// AddMonth returns the time corresponding to adding the
// given number of months to t.
// For example, AddMonth(t, 2) applied to January 1, 2011
// (= t) returns March 1, 2011.
//
// AddMonth does not normalize its result in the same way
// that Date does, so, for example, adding one month to
// October 31 yields November 30.
func AddMonth(t time.Time, months int) time.Time {
        lastMonthDay := func(t time.Time) int {
                return time.Date(t.Year(), t.Month()+1, 1, 0, 0, 0, 0, t.Location()).AddDate(0, 0, -1).Day()
        }

        // Creating 1st Date from t and adding months because AddDate() normalizes t.
        am := time.Date(t.Year(), t.Month(), 1, 0, 0, 0, 0, t.Location()).AddDate(0, months, 0)
        ad := lastMonthDay(am)

        if ld := lastMonthDay(t); t.Day() == ld || t.Day() > ad {
                return time.Date(am.Year(), am.Month(), ad, am.Hour(), am.Minute(), am.Second(), am.Nanosecond(), am.Location())
        }

        return t.AddDate(0, months, 0)
}

func main() {
        cnt := 14

        fmt.Println("First Days")
        ft := time.Date(2020, 2, 1, 0, 0, 0, 0, time.Local)
        for i := -cnt; i <= -1; i++ {
                fmt.Println(AddMonth(ft, i), "(Add", i, "month)")
        }
        fmt.Println(ft)
        for i := 1; i <= cnt; i++ {
                fmt.Println(AddMonth(ft, i), "(Add", i, "month)")
        }

        fmt.Println()

        fmt.Println("Last Days")
        lt := time.Date(2020, 2, 29, 0, 0, 0, 0, time.Local)
        for i := -cnt; i <= -1; i++ {
                fmt.Println(AddMonth(lt, i), "(Add", i, "month)")
        }
        fmt.Println(lt)
        for i := 1; i <= cnt; i++ {
                fmt.Println(AddMonth(lt, i), "(Add", i, "month)")
        }
}

実行結果

First Days
2018-12-01 00:00:00 +0000 UTC (Add -14 month)
2019-01-01 00:00:00 +0000 UTC (Add -13 month)
2019-02-01 00:00:00 +0000 UTC (Add -12 month)
2019-03-01 00:00:00 +0000 UTC (Add -11 month)
2019-04-01 00:00:00 +0000 UTC (Add -10 month)
2019-05-01 00:00:00 +0000 UTC (Add -9 month)
2019-06-01 00:00:00 +0000 UTC (Add -8 month)
2019-07-01 00:00:00 +0000 UTC (Add -7 month)
2019-08-01 00:00:00 +0000 UTC (Add -6 month)
2019-09-01 00:00:00 +0000 UTC (Add -5 month)
2019-10-01 00:00:00 +0000 UTC (Add -4 month)
2019-11-01 00:00:00 +0000 UTC (Add -3 month)
2019-12-01 00:00:00 +0000 UTC (Add -2 month)
2020-01-01 00:00:00 +0000 UTC (Add -1 month)
2020-02-01 00:00:00 +0000 UTC
2020-03-01 00:00:00 +0000 UTC (Add 1 month)
2020-04-01 00:00:00 +0000 UTC (Add 2 month)
2020-05-01 00:00:00 +0000 UTC (Add 3 month)
2020-06-01 00:00:00 +0000 UTC (Add 4 month)
2020-07-01 00:00:00 +0000 UTC (Add 5 month)
2020-08-01 00:00:00 +0000 UTC (Add 6 month)
2020-09-01 00:00:00 +0000 UTC (Add 7 month)
2020-10-01 00:00:00 +0000 UTC (Add 8 month)
2020-11-01 00:00:00 +0000 UTC (Add 9 month)
2020-12-01 00:00:00 +0000 UTC (Add 10 month)
2021-01-01 00:00:00 +0000 UTC (Add 11 month)
2021-02-01 00:00:00 +0000 UTC (Add 12 month)
2021-03-01 00:00:00 +0000 UTC (Add 13 month)
2021-04-01 00:00:00 +0000 UTC (Add 14 month)

Last Days
2018-12-31 00:00:00 +0000 UTC (Add -14 month)
2019-01-31 00:00:00 +0000 UTC (Add -13 month)
2019-02-28 00:00:00 +0000 UTC (Add -12 month)
2019-03-31 00:00:00 +0000 UTC (Add -11 month)
2019-04-30 00:00:00 +0000 UTC (Add -10 month)
2019-05-31 00:00:00 +0000 UTC (Add -9 month)
2019-06-30 00:00:00 +0000 UTC (Add -8 month)
2019-07-31 00:00:00 +0000 UTC (Add -7 month)
2019-08-31 00:00:00 +0000 UTC (Add -6 month)
2019-09-30 00:00:00 +0000 UTC (Add -5 month)
2019-10-31 00:00:00 +0000 UTC (Add -4 month)
2019-11-30 00:00:00 +0000 UTC (Add -3 month)
2019-12-31 00:00:00 +0000 UTC (Add -2 month)
2020-01-31 00:00:00 +0000 UTC (Add -1 month)
2020-02-29 00:00:00 +0000 UTC
2020-03-31 00:00:00 +0000 UTC (Add 1 month)
2020-04-30 00:00:00 +0000 UTC (Add 2 month)
2020-05-31 00:00:00 +0000 UTC (Add 3 month)
2020-06-30 00:00:00 +0000 UTC (Add 4 month)
2020-07-31 00:00:00 +0000 UTC (Add 5 month)
2020-08-31 00:00:00 +0000 UTC (Add 6 month)
2020-09-30 00:00:00 +0000 UTC (Add 7 month)
2020-10-31 00:00:00 +0000 UTC (Add 8 month)
2020-11-30 00:00:00 +0000 UTC (Add 9 month)
2020-12-31 00:00:00 +0000 UTC (Add 10 month)
2021-01-31 00:00:00 +0000 UTC (Add 11 month)
2021-02-28 00:00:00 +0000 UTC (Add 12 month)
2021-03-31 00:00:00 +0000 UTC (Add 13 month)
2021-04-30 00:00:00 +0000 UTC (Add 14 month)

月末日に関しては、12ヶ月の月末日の並びから

...,31|31,28&29,31,30,31,30,31,31,30,31,30,31|31,...

30日が連続することがないことを考慮して、以下のケースで動作確認しました。（基：基準日の月末日）

-1 基 +1

-- -- --

31,28,31

31,29,31

31,30,31

28,31,30

29,31,30

30,31,30

30,31,31

31,31,28

31,31,29

31,31,30

例）基準日が2019年2月28日で前後2ヶ月の月末日を出力するmain()関数内のコード。

tl := time.Date(2019, 2, 28, 0, 0, 0, 0, time.Local)

fmt.Println(AddMonth(tl, -2), "(Add -2 month)")

fmt.Println(AddMonth(tl, -1), "(Add -1 month)")

fmt.Println(tl)

fmt.Println(AddMonth(tl, 1), "(Add 1 month)")

fmt.Println(AddMonth(tl, 2), "(Add 2 month)")

2020.05.02 11月30日の時に-1ヶ月すると10月31日ではなく10月30日になっていた不具合を修正しました。

2020.05.03 2020年3月31日の時に-1ヶ月すると2月29日ではなく3月1日になっていた不具合を修正しました。

ゴキゲンBlog

2020年5月4日月曜日

Azure SDK for Goでの認証方式