github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/kms/identity-manager.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package kms
    19  
    20  import (
    21  	"context"
    22  
    23  	"github.com/minio/kms-go/kes"
    24  )
    25  
    26  // IdentityManager is the generic interface that handles KMS identity operations
    27  type IdentityManager interface {
    28  	// DescribeIdentity describes an identity by returning its metadata.
    29  	// e.g. which policy is currently assigned and whether its an admin identity.
    30  	DescribeIdentity(ctx context.Context, identity string) (*kes.IdentityInfo, error)
    31  
    32  	// DescribeSelfIdentity describes the identity issuing the request.
    33  	// It infers the identity from the TLS client certificate used to authenticate.
    34  	// It returns the identity and policy information for the client identity.
    35  	DescribeSelfIdentity(ctx context.Context) (*kes.IdentityInfo, *kes.Policy, error)
    36  
    37  	// ListIdentities lists all identities.
    38  	ListIdentities(ctx context.Context) (*kes.ListIter[kes.Identity], error)
    39  }