ssh

package
v1.0.5019 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 16, 2025 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SSHDESEDE3CBC = "3des-cbc"

	SSHAES128CBC = "aes128-cbc"
	SSHAES192CBC = "aes192-cbc"
	SSHAES256CBC = "aes256-cbc"

	SSHAES128CTR = "aes128-ctr"
	SSHAES192CTR = "aes192-ctr"
	SSHAES256CTR = "aes256-ctr"

	SSHAES128GCM = "aes128-gcm@openssh.com"
	SSHAES256GCM = "aes256-gcm@openssh.com"

	// RC4 = arcfour
	SSHArcfour    = "arcfour"
	SSHArcfour128 = "arcfour128"
	SSHArcfour256 = "arcfour256"

	SSHBlowfishCBC = "blowfish-cbc"

	// cast5 = cast128
	SSHCast128CBC = "cast128-cbc"

	SSHChacha20poly1305 = "chacha20-poly1305@openssh.com"

	SSHSM4CBC = "sm4-cbc"
	SSHSM4CTR = "sm4-ctr"
)
View Source 
var AES128CBC = CipherCBC{
	// contains filtered or unexported fields
}

AES128CBC is the 128-bit key AES cipher in CBC mode.

View Source 
var AES128CTR = CipherCTR{
	// contains filtered or unexported fields
}

AES128CTR is the 128-bit key AES cipher in CTR mode.

View Source 
var AES128GCM = CipherGCM{
	// contains filtered or unexported fields
}

AES128GCM is the 128-bit key AES cipher in GCM mode.

View Source 
var AES192CBC = CipherCBC{
	// contains filtered or unexported fields
}

AES192CBC is the 192-bit key AES cipher in CBC mode.

View Source 
var AES192CTR = CipherCTR{
	// contains filtered or unexported fields
}

AES192CTR is the 192-bit key AES cipher in CTR mode.

View Source 
var AES256CBC = CipherCBC{
	// contains filtered or unexported fields
}

AES256CBC is the 256-bit key AES cipher in CBC mode.

View Source 
var AES256CTR = CipherCTR{
	// contains filtered or unexported fields
}

AES256CTR is the 256-bit key AES cipher in CTR mode.

View Source 
var AES256GCM = CipherGCM{
	// contains filtered or unexported fields
}

AES256GCM is the 256-bit key AES cipher in GCM mode.

View Source 
var Arcfour = CipherRC4{
	// contains filtered or unexported fields
}

Arcfour is the (from 1 to 256 bytes) key RC4 cipher.

View Source 
var Arcfour128 = CipherRC4{
	// contains filtered or unexported fields
}

Arcfour128 is the 128-bit key RC4 cipher.

View Source 
var Arcfour256 = CipherRC4{
	// contains filtered or unexported fields
}

Arcfour256 is the 256-bit key RC4 cipher.

View Source 
var BlowfishCBC = CipherCBC{
	// contains filtered or unexported fields
}

BlowfishCBC is the key (from 1 to 56 bytes) blowfish cipher in CBC mode.

View Source 
var Cast128CBC = CipherCBC{
	// contains filtered or unexported fields
}

Cast128CBC is the 128-bit key cast5 cipher in CBC mode.

View Source 
var Chacha20poly1305 = CipherChacha20poly1305{
	// contains filtered or unexported fields
}

Chacha20poly1305 is the 256-bit chacha20poly1305 cipher.

View Source 
var DESEDE3CBC = CipherCBC{
	// contains filtered or unexported fields
}

DESEDE3CBC is the 168-bit key 3DES cipher in CBC mode.

View Source 
var DefaultOpts = Opts{
	Cipher: AES256CTR,
	KDFOpts: BcryptOpts{
		SaltSize: 16,
		Rounds:   16,
	},
}

Default options

View Source 
var (
	KeyAlgoSM2 = "ssh-sm2"
)
View Source 
var SM4CBC = CipherCBC{
	// contains filtered or unexported fields
}

SM4CBC is the 128-bit SM4 AES cipher in CBC mode.

View Source 
var SM4CTR = CipherCTR{
	// contains filtered or unexported fields
}

SM4CTR is the 128-bit SM4 AES cipher in CTR mode.

Functions

func AddCipher 

func AddCipher(name string, cipher func() Cipher)

添加加密 add Cipher

func AddKDF 

func AddKDF(name string, params func() KDFParameters)

添加 kdf 方式 Add KDF

func AddKey 

func AddKey(name string, key func() Key)

添加 Key Add Key

func AddPubKeyParser added in v1.0.2002 

func AddPubKeyParser(name string, parser PubKeyParser)

添加解析方式方式 Add PubKey Parser

func EncodeSSHKeyToPem added in v1.0.1030 

func EncodeSSHKeyToPem(keyBlock *pem.Block) []byte

Encode SSHKey to pem

func GetStructName 

func GetStructName(s any) (name string)

反射获取结构体名称 Get Struct Name by reflect

func MarshalAuthorizedKey added in v1.0.2002 

func MarshalAuthorizedKey(key ssh.PublicKey) []byte

Marshal AuthorizedKey

func MarshalAuthorizedKeyWithComment added in v1.0.2002 

func MarshalAuthorizedKeyWithComment(key ssh.PublicKey, comment string) []byte

创建带信息的 key Marshal AuthorizedKey With Comment

func MarshalOpenSSHPrivateKey 

func MarshalOpenSSHPrivateKey(rand io.Reader, key crypto.PrivateKey, comment string) (*pem.Block, error)

Marshal OpenSSH PrivateKey

func MarshalOpenSSHPrivateKeyWithPassword added in v1.0.1030 

func MarshalOpenSSHPrivateKeyWithPassword(rand io.Reader, key crypto.PrivateKey, comment string, password []byte, opts ...Opts) (*pem.Block, error)

Marshal OpenSSH PrivateKey With Password

func NewPublicKey added in v1.0.2002 

func NewPublicKey(key any) (out ssh.PublicKey, err error)

RSA | DSA | SM2 | ECDSA | SKECDSA | ED25519 | SKEd25519 CertAlgoRSAv01 | CertAlgoDSAv01 CertAlgoECDSA256v01 | CertAlgoECDSA384v01 CertAlgoECDSA521v01 | CertAlgoSKECDSA256v01 CertAlgoED25519v01 | CertAlgoSKED25519v01

func NewSM2PrivateKey added in v1.0.2002 

func NewSM2PrivateKey(key *sm2.PrivateKey) ssh.Signer

func NewSM2PublicKey added in v1.0.2002 

func NewSM2PublicKey(key *sm2.PublicKey) ssh.PublicKey

func NewSignerFromKey added in v1.0.2002 

func NewSignerFromKey(key any) (out ssh.Signer, err error)

func ParseAuthorizedKey added in v1.0.2002 

func ParseAuthorizedKey(in []byte) (out ssh.PublicKey, comment string, options []string, rest []byte, err error)

func ParseKnownHosts added in v1.0.2002 

func ParseKnownHosts(in []byte) (marker string, hosts []string, pubKey ssh.PublicKey, comment string, rest []byte, err error)

Parse KnownHosts

func ParseOpenSSHPrivateKey 

func ParseOpenSSHPrivateKey(key []byte) (crypto.PrivateKey, string, error)

Parse OpenSSH PrivateKey

func ParseOpenSSHPrivateKeyToInfo added in v1.0.5017 

func ParseOpenSSHPrivateKeyToInfo(key []byte) (openSSHPrivateKey, error)

func ParseOpenSSHPrivateKeyWithPassword added in v1.0.1030 

func ParseOpenSSHPrivateKeyWithPassword(key []byte, password []byte) (crypto.PrivateKey, string, error)

Parse OpenSSH PrivateKey With Password

func ParsePrivateKey added in v1.0.2002 

func ParsePrivateKey(pemBytes []byte) (ssh.Signer, error)

func ParsePrivateKeyWithPassphrase added in v1.0.2002 

func ParsePrivateKeyWithPassphrase(pemBytes, passphrase []byte) (ssh.Signer, error)

func ParsePublicKey added in v1.0.2002 

func ParsePublicKey(in []byte) (out ssh.PublicKey, err error)

func ParseRawPrivateKey added in v1.0.2002 

func ParseRawPrivateKey(pemBytes []byte) (out any, err error)

func ParseRawPrivateKeyWithPassphrase added in v1.0.2002 

func ParseRawPrivateKeyWithPassphrase(pemBytes, passphrase []byte) (out any, err error)

func ParseSM2AuthorizedKey added in v1.0.2002 

func ParseSM2AuthorizedKey(in []byte) (out ssh.PublicKey, comment string, options []string, rest []byte, err error)

func ParseSM2PrivateKeyFromPem added in v1.0.2039 

func ParseSM2PrivateKeyFromPem(privateKeyPem []byte, pwd []byte) (*sm2.PrivateKey, error)

func ParseSM2PublicKey added in v1.0.2002 

func ParseSM2PublicKey(in []byte) (out ssh.PublicKey, err error)

func ParseSM2RawPrivateKey added in v1.0.2002 

func ParseSM2RawPrivateKey(pemBytes []byte) (any, error)

func ParseSM2RawPrivateKeyWithPassphrase added in v1.0.2002 

func ParseSM2RawPrivateKeyWithPassphrase(pemBytes, passphrase []byte) (any, error)

func ParseSSHKeyPem added in v1.0.1030 

func ParseSSHKeyPem(data []byte) ([]byte, error)

Parse SSHKey Pem data

Types

type BcryptOpts 

type BcryptOpts struct {
	SaltSize int
	Rounds   int
}

BcryptOpts options

func (BcryptOpts) DeriveKey 

func (this BcryptOpts) DeriveKey(random io.Reader, password []byte, size int) ([]byte, string, error)

func (BcryptOpts) GetSaltSize 

func (this BcryptOpts) GetSaltSize() int

func (BcryptOpts) Name 

func (this BcryptOpts) Name() string

type BcryptbinOpts added in v1.0.5013 

type BcryptbinOpts struct {
	SaltSize int
	Rounds   int
}

BcryptbinOpts options

func (BcryptbinOpts) DeriveKey added in v1.0.5013 

func (this BcryptbinOpts) DeriveKey(random io.Reader, password []byte, size int) (key []byte, params string, err error)

func (BcryptbinOpts) GetSaltSize added in v1.0.5013 

func (this BcryptbinOpts) GetSaltSize() int

func (BcryptbinOpts) Name added in v1.0.5013 

func (this BcryptbinOpts) Name() string

type Cipher 

type Cipher interface {
	// 名称
	// Name
	Name() string

	// 值大小
	// KeySize
	KeySize() int

	// 块大小
	// BlockSize
	BlockSize() int

	// 加密, 返回: [加密后数据, error]
	// Encrypt, return [Encrypted, error]
	Encrypt(key, plaintext []byte) ([]byte, error)

	// 解密
	// Decrypt
	Decrypt(key, ciphertext []byte) ([]byte, error)
}

加密接口 Cipher interface

func GetCipherFromName added in v1.0.1029 

func GetCipherFromName(name string) Cipher

get Cipher from name

func ParseCipher 

func ParseCipher(cipherName string) (Cipher, error)

type CipherCBC 

type CipherCBC struct {
	// contains filtered or unexported fields
}

cbc mode

func (CipherCBC) BlockSize 

func (this CipherCBC) BlockSize() int

BlockSize

func (CipherCBC) Decrypt 

func (this CipherCBC) Decrypt(key, ciphertext []byte) ([]byte, error)

Decrypt

func (CipherCBC) Encrypt 

func (this CipherCBC) Encrypt(key, plaintext []byte) ([]byte, error)

Encrypt

func (CipherCBC) KeySize 

func (this CipherCBC) KeySize() int

KeySize

func (CipherCBC) Name 

func (this CipherCBC) Name() string

oid name

type CipherCTR 

type CipherCTR struct {
	// contains filtered or unexported fields
}

CTR mode

func (CipherCTR) BlockSize 

func (this CipherCTR) BlockSize() int

BlockSize

func (CipherCTR) Decrypt 

func (this CipherCTR) Decrypt(key, ciphertext []byte) ([]byte, error)

Decrypt

func (CipherCTR) Encrypt 

func (this CipherCTR) Encrypt(key, plaintext []byte) ([]byte, error)

Encrypt

func (CipherCTR) KeySize 

func (this CipherCTR) KeySize() int

KeySize

func (CipherCTR) Name 

func (this CipherCTR) Name() string

oid name

type CipherChacha20poly1305 added in v1.0.1031 

type CipherChacha20poly1305 struct {
	// contains filtered or unexported fields
}

Chacha20poly1305 Encrypt/Decrypt

func (CipherChacha20poly1305) BlockSize added in v1.0.1031 

func (this CipherChacha20poly1305) BlockSize() int

BlockSize

func (CipherChacha20poly1305) Decrypt added in v1.0.1031 

func (this CipherChacha20poly1305) Decrypt(key, ciphertext []byte) ([]byte, error)

Decrypt

func (CipherChacha20poly1305) Encrypt added in v1.0.1031 

func (this CipherChacha20poly1305) Encrypt(key, plaintext []byte) ([]byte, error)

Encrypt

func (CipherChacha20poly1305) KeySize added in v1.0.1031 

func (this CipherChacha20poly1305) KeySize() int

KeySize

func (CipherChacha20poly1305) Name added in v1.0.1031 

func (this CipherChacha20poly1305) Name() string

oid name

type CipherGCM added in v1.0.1031 

type CipherGCM struct {
	// contains filtered or unexported fields
}

gcm mode

func (CipherGCM) BlockSize added in v1.0.1031 

func (this CipherGCM) BlockSize() int

BlockSize

func (CipherGCM) Decrypt added in v1.0.1031 

func (this CipherGCM) Decrypt(key, ciphertext []byte) ([]byte, error)

Decrypt

func (CipherGCM) Encrypt added in v1.0.1031 

func (this CipherGCM) Encrypt(key, plaintext []byte) ([]byte, error)

Encrypt

func (CipherGCM) KeySize added in v1.0.1031 

func (this CipherGCM) KeySize() int

KeySize

func (CipherGCM) Name added in v1.0.1031 

func (this CipherGCM) Name() string

oid name

type CipherRC4 added in v1.0.1031 

type CipherRC4 struct {
	// contains filtered or unexported fields
}

CipherRC4 Encrypt/Decrypt

func (CipherRC4) BlockSize added in v1.0.1031 

func (this CipherRC4) BlockSize() int

BlockSize

func (CipherRC4) Decrypt added in v1.0.1031 

func (this CipherRC4) Decrypt(key, ciphertext []byte) ([]byte, error)

Decrypt

func (CipherRC4) Encrypt added in v1.0.1031 

func (this CipherRC4) Encrypt(key, plaintext []byte) ([]byte, error)

Encrypt

func (CipherRC4) KeySize added in v1.0.1031 

func (this CipherRC4) KeySize() int

KeySize

func (CipherRC4) Name added in v1.0.1031 

func (this CipherRC4) Name() string

oid name

func (CipherRC4) WithKeySize added in v1.0.1031 

func (this CipherRC4) WithKeySize(keySize int) CipherRC4

With KeySize

type KDFOpts 

type KDFOpts interface {
	// 名称
	// Name
	Name() string

	// 生成密钥
	// DeriveKey func
	DeriveKey(random io.Reader, password []byte, size int) (key []byte, params string, err error)

	// 随机数大小
	// Get SaltSize
	GetSaltSize() int
}

KDF 设置接口 KDF Options

type KDFParameters 

type KDFParameters interface {
	// 生成密钥
	// DeriveKey func
	DeriveKey(password []byte, kdfOpts string, size int) (key []byte, err error)
}

数据接口 KDF Parameters

func ParsePBKDF added in v1.0.5013 

func ParsePBKDF(kdfName string) (KDFParameters, error)

Parse PBKDF

type Key 

type Key interface {
	// 包装
	// Marshal
	Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

	// 解析
	// Parse
	Parse(data []byte) (crypto.PrivateKey, string, error)
}

Key 接口 Key interface

func ParseKeyType added in v1.0.5013 

func ParseKeyType(keyName string) (Key, error)

type KeyDSA added in v1.0.5015 

type KeyDSA struct{}

DSA key

func (KeyDSA) Marshal added in v1.0.5015 

func (this KeyDSA) Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

Marshal key

func (KeyDSA) Parse added in v1.0.5015 

func (this KeyDSA) Parse(rest []byte) (crypto.PrivateKey, string, error)

Parse key

type KeyECDSA added in v1.0.5013 

type KeyECDSA struct{}

ecdsa key

func (KeyECDSA) Marshal added in v1.0.5013 

func (this KeyECDSA) Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

Marshal key

func (KeyECDSA) Parse added in v1.0.5013 

func (this KeyECDSA) Parse(rest []byte) (crypto.PrivateKey, string, error)

Parse key

type KeyEdDSA added in v1.0.5013 

type KeyEdDSA struct{}

EdDSA key

func (KeyEdDSA) Marshal added in v1.0.5013 

func (this KeyEdDSA) Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

Marshal key

func (KeyEdDSA) Parse added in v1.0.5013 

func (this KeyEdDSA) Parse(rest []byte) (crypto.PrivateKey, string, error)

Parse key

type KeyRSA added in v1.0.5013 

type KeyRSA struct{}

RSA key

func (KeyRSA) Marshal added in v1.0.5013 

func (this KeyRSA) Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

Marshal key

func (KeyRSA) Parse added in v1.0.5013 

func (this KeyRSA) Parse(rest []byte) (crypto.PrivateKey, string, error)

Parse key

type KeySM2 added in v1.0.1031 

type KeySM2 struct{}

SM2 key

func (KeySM2) Marshal added in v1.0.1031 

func (this KeySM2) Marshal(key crypto.PrivateKey, comment string) (string, []byte, []byte, error)

Marshal key

func (KeySM2) Parse added in v1.0.1031 

func (this KeySM2) Parse(rest []byte) (crypto.PrivateKey, string, error)

Parse key

type Opts added in v1.0.1030 

type Opts struct {
	Cipher  Cipher
	KDFOpts KDFOpts
}

options

type PubKeyParser added in v1.0.2002 

type PubKeyParser = func([]byte) (ssh.PublicKey, []byte, error)

解析方式 PubKey Parser

func GetPubKeyParser added in v1.0.2002 

func GetPubKeyParser(name string) PubKeyParser

获取解析方式方式 Get PubKey Parser

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.