github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/auth/entities.go (about)

     1  // Copyright (c) 2023 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package auth
    22  
    23  import (
    24  	"errors"
    25  )
    26  
    27  // InboundCredentials encapsulates credentials for inbound RPCs to dbnode.
    28  type InboundCredentials struct {
    29  	Username string
    30  	Digest   string
    31  	Type     CredentialType
    32  }
    33  
    34  // Validate validates the InboundCredentials.
    35  func (c *InboundCredentials) Validate() error {
    36  	if c.Username == "" {
    37  		return errors.New("username field is empty for inbound")
    38  	}
    39  
    40  	if c.Digest == "" {
    41  		return errors.New("digest field is empty for inbound")
    42  	}
    43  
    44  	if c.Type != CredentialClient {
    45  		return errors.New("incorrect cred type field for inbound")
    46  	}
    47  
    48  	return nil
    49  }
    50  
    51  // OutboundCredentials encapsulates credentials for outbound RPCs from dbnode.
    52  type OutboundCredentials struct {
    53  	Username string
    54  	Password string
    55  	Zone     string
    56  	Type     CredentialType
    57  }
    58  
    59  // Validate validates the OutboundCredentials.
    60  func (c *OutboundCredentials) Validate() error {
    61  	if c.Username == "" {
    62  		return errors.New("username field is empty for outbound")
    63  	}
    64  
    65  	if c.Password == "" {
    66  		return errors.New("password field is empty for outbound")
    67  	}
    68  
    69  	if c.Type == CredentialUnknown {
    70  		return errors.New("incorrect cred type field for outbound")
    71  	}
    72  
    73  	if c.Zone == "" {
    74  		return errors.New("zone field is not set for outbound")
    75  	}
    76  	return nil
    77  }