scmauth

Documentation

Index

• Constants
• type SCMAuth
• type SSHPrivateKey
  • func (_ SSHPrivateKey) Name() string
  • func (_ SSHPrivateKey) Setup(baseDir string) error

Constants

const SSHPrivateKeyMethodName = "ssh-privatekey"

Types

type SCMAuth

type SCMAuth interface {
	Name() string
	Setup(baseDir string) error
}

SCMAuth is an interface implemented by different authentication providers which are responsible for setting up the credentials to be used when accessing private repository.

type SSHPrivateKey

type SSHPrivateKey struct{}

SSHPrivateKey implements SCMAuth interface for using SSH private keys.

func (SSHPrivateKey) Name

func (_ SSHPrivateKey) Name() string

Name returns the name of this auth method.

func (SSHPrivateKey) Setup

func (_ SSHPrivateKey) Setup(baseDir string) error

Setup creates a wrapper script for SSH command to be able to use the provided SSH key while accessing private repository.