github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/auth/enum.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  // CredentialType designates credentials for different connection edges.
    24  type CredentialType int
    25  
    26  const (
    27  	// CredentialUnknown defines unknown connection edge.
    28  	CredentialUnknown CredentialType = iota
    29  
    30  	// CredentialClient defines m3db client to dbnode connection credentials.
    31  	CredentialClient
    32  
    33  	// CredentialPeer defines dbnode to dbnode connections credentials.
    34  	CredentialPeer
    35  
    36  	// CredentialEtcd defines dbnode to etcd connections credentials.
    37  	CredentialEtcd
    38  )
    39  
    40  // Mode designates a type of authentication.
    41  type Mode int
    42  
    43  const (
    44  	// ModeUnknown is unknown authentication type case.
    45  	ModeUnknown Mode = iota
    46  
    47  	// ModeNoAuth is no authentication type case.
    48  	ModeNoAuth
    49  
    50  	// ModeShadow mode runs authentication in shadow mode. Credentials will be passed
    51  	// by respective peers/clients but will not be used to reject RPCs in case of auth failure.
    52  	ModeShadow
    53  
    54  	// ModeEnforced mode runs dbnode in enforced authentication mode. RPCs to dbnode will be rejected
    55  	// if auth fails.
    56  	ModeEnforced
    57  )