Goaにおけるセキュリティ

var BasicAuth = BasicAuthSecurity("basic", func() {
    Description("ユーザー名とパスワードを使用したBasic認証")
})

var APIKeyAuth = APIKeySecurity("api_key", func() {
    Description("APIキーを要求することでエンドポイントを保護します。")
})

var JWTAuth = JWTSecurity("jwt", func() {
    Description("有効なJWTトークンを要求することでエンドポイントを保護します。")
    Scope("api:read", "APIへの読み取りアクセス")
    Scope("api:write", "APIへの書き込みアクセス")
})

var OAuth2 = OAuth2Security("oauth2", func() {
    Description("OAuth2認証")
    ImplicitFlow("/authorization")
    Scope("api:write", "書き込みアクセス")
    Scope("api:read", "読み取りアクセス")
})

package design

import (
    . "goa.design/goa/v3/dsl"
)

// セキュリティスキームを定義
var BasicAuth = BasicAuthSecurity("basic", func() {
    Description("Basic認証")
})

var APIKeyAuth = APIKeySecurity("api_key", func() {
    Description("APIキーを要求することでエンドポイントを保護します。")
})

var JWTAuth = JWTSecurity("jwt", func() {
    Description("有効なJWTトークンを要求することでエンドポイントを保護します。")
})

// APIレベルでセキュリティを適用
var _ = API("hierarchy", func() {
    Title("セキュリティ例API")
    Description("このAPIは、API、サービス、またはメソッドレベルでセキュリティを" +
        "使用する効果を示します")

    // すべてのエンドポイントのデフォルトセキュリティスキームとしてBasic認証を設定
    Security(BasicAuth)
})

var _ = Service("default_service", func() {
    Method("default", func() {
        Description("デフォルトサービスのdefaultメソッドはBasic認証で" +
            "保護されています")
        // Basic認証に必要なペイロードを定義
        Payload(func() {
            Username("username")  // ユーザー名フィールドの特別なDSL
            Password("password")  // パスワードフィールドの特別なDSL
            Required("username", "password")
        })
        HTTP(func() { GET("/default") })
    })
})

var _ = Service("api_key_service", func() {
    Description("svcサービスはAPIキーベースの認証で保護されています")
    HTTP(func() { Path("/svc") })

    // このサービス全体のAPIレベルのセキュリティを上書き
    Security(APIKeyAuth)

    Method("default", func() {
        // このメソッドはサービスレベルのAPIキーセキュリティを使用
        Payload(func() {
            APIKey("api_key", "key", String, func() {
                Description("認証に使用されるAPIキー")
            })
            Required("key")
        })
        HTTP(func() { GET("/default") })
    })

    Method("secure", func() {
        // この特定のメソッドのサービスレベルのセキュリティを上書き
        Security(JWTAuth)
        Description("このメソッドは有効なJWTトークンを必要とします。")
        Payload(func() {
            Token("token", String, func() {
                Description("認証に使用されるJWT")
            })
            Required("token")
        })
        HTTP(func() { GET("/secure") })
    })

    Method("unsecure", func() {
        Description("このメソッドは保護されていません。")
        // このメソッドのすべてのセキュリティ要件を削除
        NoSecurity()
    })
})

Method("health", func() {
    Description("公開ヘルスチェックエンドポイント")
    NoSecurity()
    HTTP(func() { GET("/health") })
})