README
¶
putty
Go package to parse PuTTY private key formats. Go 1.13 or above is required.
Example
package main
import (
"log"
"github.com/liornabat/putty"
)
func main() {
var privateKey interface{}
// read the key
puttyKey, err := putty.NewFromFile("test.ppk")
if err != nil {
log.Fatal(err)
}
// parse putty key
if puttyKey.Encryption != "none" {
// If the key is encrypted, decrypt it
privateKey, err = puttyKey.ParseRawPrivateKey([]byte("testkey"))
if err != nil {
log.Fatal(err)
}
} else {
privateKey, err = puttyKey.ParseRawPrivateKey(nil)
if err != nil {
log.Fatal(err)
}
}
// init an empty public key with version 3
outKey := putty.Key{Version: 3}
// set the private key
outKey.SetKey(privateKey)
// print out the ppk file
fmt.Printf("%s\n", outKey.Marshal())
log.Printf("%+#v", privateKey)
}
Documentation
¶
Index ¶
- type Key
- func (k Key) Clone() *Key
- func (k *Key) Encrypt(random io.Reader, password []byte) error
- func (k *Key) Load(b []byte) error
- func (k *Key) LoadFromFile(path string) error
- func (k *Key) LoadSSH1(b []byte) error
- func (k *Key) LoadSSH1WithPassword(b []byte, password string) error
- func (k *Key) Marshal() (ret []byte, err error)
- func (k *Key) MarshalSSH1() ([]byte, error)
- func (k *Key) MarshalSSH1WithPassword(password string) ([]byte, error)
- func (k *Key) ParseRawPrivateKey(password []byte) (ret interface{}, err error)
- func (k *Key) ParseRawPublicKey() (interface{}, error)
- func (k *Key) SetKey(key interface{}) (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Key ¶
type Key struct {
Version int
Algo string
PublicKey []byte
PrivateKey []byte
KeyDerivation string
Argon2Memory uint32
Argon2Passes uint32
Argon2Parallelism uint8
Argon2Salt []byte
Comment string
Encryption string
PrivateMac []byte
// contains filtered or unexported fields
}
func NewFromFile ¶
NewFromFile creates new PuTTY structure from file
func (*Key) LoadFromFile ¶
LoadFromFile reads PuTTY key and loads its contents into the struct
func (*Key) LoadSSH1WithPassword ¶
func (*Key) MarshalSSH1 ¶
func (*Key) MarshalSSH1WithPassword ¶
func (*Key) ParseRawPrivateKey ¶
ParseRawPrivateKey returns a private key from a PuTTY encoded private key. It supports RSA (PKCS#1), DSA (OpenSSL), ECDSA and ED25519 private keys.
func (*Key) ParseRawPublicKey ¶
ParseRawPublicKey returns a public key from a PuTTY encoded private key. It supports the same key types as ParseRawPrivateKey, and will work even if the private part is encrypted
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.