go.uber.org/yarpc@v1.72.1/api/transport/tls/mode.go (about)

     1  // Copyright (c) 2022 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 tls
    22  
    23  import (
    24  	"encoding"
    25  	"fmt"
    26  )
    27  
    28  const (
    29  	// Disabled TLS mode allows plaintext connections only.
    30  	Disabled Mode = iota
    31  
    32  	// Permissive TLS mode allows both TLS and plaintext connections.
    33  	Permissive
    34  
    35  	// Enforced TLS mode allows accepts TLS connections only.
    36  	Enforced
    37  )
    38  
    39  var (
    40  	_ fmt.Stringer             = (*Mode)(nil)
    41  	_ encoding.TextUnmarshaler = (*Mode)(nil)
    42  )
    43  
    44  // Mode represents the TLS mode of the transport.
    45  type Mode uint16
    46  
    47  // UnmarshalText implements encoding.TextUnmarshaler.
    48  func (t *Mode) UnmarshalText(text []byte) error {
    49  	switch s := string(text); s {
    50  	case "disabled":
    51  		*t = Disabled
    52  	case "permissive":
    53  		*t = Permissive
    54  	case "enforced":
    55  		*t = Enforced
    56  	default:
    57  		return fmt.Errorf("unknown tls mode string: %s", string(text))
    58  	}
    59  
    60  	return nil
    61  }