1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
|
package pgp
import (
"bytes"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
"syscall"
"time"
"github.com/pkg/errors"
"github.com/ProtonMail/go-crypto/openpgp"
"github.com/ProtonMail/go-crypto/openpgp/clearsign"
openpgp_errors "github.com/ProtonMail/go-crypto/openpgp/errors"
"github.com/ProtonMail/go-crypto/openpgp/packet"
"golang.org/x/term"
)
// Test interface
var (
_ Signer = &GoSigner{}
_ Verifier = &GoVerifier{}
)
// Internal errors
var (
errWrongPassphrase = errors.New("unable to decrypt the key, passphrase is wrong")
)
// GoSigner is implementation of Signer interface using Go internal OpenPGP library
type GoSigner struct {
keyRef string
keyringFile, secretKeyringFile string
passphrase, passphraseFile string
batch bool
publicKeyring openpgp.EntityList
secretKeyring openpgp.EntityList
signer *openpgp.Entity
signerConfig *packet.Config
}
// SetBatch controls whether we allowed to interact with user, for example
// for getting the passphrase from stdin.
func (g *GoSigner) SetBatch(batch bool) {
g.batch = batch
}
// SetKey sets key ID to use when signing files
func (g *GoSigner) SetKey(keyRef string) {
g.keyRef = keyRef
}
// SetKeyRing allows to set custom keyring and secretkeyring
func (g *GoSigner) SetKeyRing(keyring, secretKeyring string) {
g.keyringFile, g.secretKeyringFile = keyring, secretKeyring
}
// SetPassphrase sets passphrase params
func (g *GoSigner) SetPassphrase(passphrase, passphraseFile string) {
g.passphrase, g.passphraseFile = passphrase, passphraseFile
}
// Init verifies availability of gpg & presence of keys
func (g *GoSigner) Init() error {
g.signerConfig = &packet.Config{
DefaultCompressionAlgo: packet.CompressionZLIB,
CompressionConfig: &packet.CompressionConfig{
Level: 9,
},
}
if g.passphraseFile != "" {
passF, err := os.Open(g.passphraseFile)
if err != nil {
return errors.Wrap(err, "error opening passphrase file")
}
defer func() {
_ = passF.Close()
}()
contents, err := io.ReadAll(passF)
if err != nil {
return errors.Wrap(err, "error reading passphrase file")
}
g.passphrase = strings.TrimSpace(string(contents))
}
if g.keyringFile == "" {
g.keyringFile = "pubring.gpg"
}
if g.secretKeyringFile == "" {
g.secretKeyringFile = "secring.gpg"
}
var err error
g.publicKeyring, err = loadKeyRing(g.keyringFile, false)
if err != nil {
return errors.Wrap(err, "error loading public keyring")
}
g.secretKeyring, err = loadKeyRing(g.secretKeyringFile, false)
if err != nil {
return errors.Wrap(err, "error load secret keyring")
}
if g.keyRef == "" {
// no key reference, pick the first key
for _, signer := range g.secretKeyring {
if !validEntity(signer) {
continue
}
g.signer = signer
break
}
if g.signer == nil {
return fmt.Errorf("looks like there are no keys in gpg, please create one (official manual: http://www.gnupg.org/gph/en/manual.html)")
}
} else {
pickKeyLoop:
for _, signer := range g.secretKeyring {
key := KeyFromUint64(signer.PrimaryKey.KeyId)
if key.Matches(Key(g.keyRef)) {
g.signer = signer
break
}
if !validEntity(signer) {
continue
}
for name := range signer.Identities {
if strings.Contains(name, g.keyRef) {
g.signer = signer
break pickKeyLoop
}
}
}
if g.signer == nil {
return errors.Errorf("couldn't find key for key reference %v", g.keyRef)
}
}
if g.signer.PrivateKey.Encrypted {
i := 0
for name := range g.signer.Identities {
if i == 0 {
fmt.Printf("openpgp: Passphrase is required to unlock private key \"%s\"\n", name)
} else {
fmt.Printf(" aka \"%s\"\n", name)
}
i++
}
fmt.Printf("openpgp: %s-bit %s key, ID %s, created %s\n",
keyBits(g.signer.PrimaryKey.PublicKey),
pubkeyAlgorithmName(g.signer.PrimaryKey.PubKeyAlgo),
KeyFromUint64(g.signer.PrimaryKey.KeyId),
g.signer.PrimaryKey.CreationTime.Format("2006-01-02"))
if g.passphrase == "" {
if g.batch {
return errors.New("key is locked with passphrase, but no passphrase was given in batch mode")
}
for attempt := 0; attempt < 3; attempt++ {
fmt.Print("\nEnter passphrase: ")
var bytePassphrase []byte
bytePassphrase, err = term.ReadPassword(int(syscall.Stdin))
if err != nil {
return errors.Wrap(err, "error reading passphare")
}
g.passphrase = string(bytePassphrase)
err = g.decryptKey()
if err == nil || err != errWrongPassphrase {
break
}
fmt.Print("\nWrong passphrase, please try again.\n")
}
} else {
err = g.decryptKey()
}
if err != nil {
return err
}
}
return nil
}
func (g *GoSigner) decryptKey() error {
err := g.signer.PrivateKey.Decrypt([]byte(g.passphrase))
if err == nil {
return nil
}
if e, ok := err.(openpgp_errors.StructuralError); ok {
if string(e) == "private key checksum failure" {
return errWrongPassphrase
}
}
return errors.Wrap(err, "error unlocking private key")
}
// DetachedSign signs file with detached signature in ASCII format
func (g *GoSigner) DetachedSign(source string, destination string) error {
fmt.Printf("openpgp: signing file '%s'...\n", filepath.Base(source))
message, err := os.Open(source)
if err != nil {
return errors.Wrap(err, "error opening source file")
}
defer func() {
_ = message.Close()
}()
signature, err := os.Create(destination)
if err != nil {
return errors.Wrap(err, "error creating signature file")
}
defer func() {
_ = signature.Close()
}()
err = openpgp.ArmoredDetachSign(signature, g.signer, message, g.signerConfig)
if err != nil {
return errors.Wrap(err, "error creating detached signature")
}
return nil
}
// ClearSign clear-signs the file
func (g *GoSigner) ClearSign(source string, destination string) error {
fmt.Printf("openpgp: clearsigning file '%s'...\n", filepath.Base(source))
message, err := os.Open(source)
if err != nil {
return errors.Wrap(err, "error opening source file")
}
defer func() {
_ = message.Close()
}()
clearsigned, err := os.Create(destination)
if err != nil {
return errors.Wrap(err, "error creating clearsigned file")
}
defer func() {
_ = clearsigned.Close()
}()
stream, err := clearsign.Encode(clearsigned, g.signer.PrivateKey, g.signerConfig)
if err != nil {
return errors.Wrap(err, "error initializing clear signer")
}
_, err = io.Copy(stream, message)
if err != nil {
_ = stream.Close()
return errors.Wrap(err, "error generating clearsigned signature")
}
err = stream.Close()
if err != nil {
return errors.Wrap(err, "error generating clearsigned signature")
}
return nil
}
// GoVerifier is implementation of Verifier interface using Go internal OpenPGP library
type GoVerifier struct {
keyRingFiles []string
trustedKeyring openpgp.EntityList
}
// InitKeyring verifies that gpg is installed and some keys are trusted
func (g *GoVerifier) InitKeyring(verbose bool) error {
var err error
if len(g.keyRingFiles) == 0 {
g.trustedKeyring, err = loadKeyRing("trustedkeys.gpg", true)
if err != nil {
return errors.Wrap(err, "failure loading trustedkeys.gpg keyring")
}
} else {
for _, file := range g.keyRingFiles {
var keyring openpgp.EntityList
keyring, err = loadKeyRing(file, false)
if err != nil {
return errors.Wrapf(err, "failure loading %s keyring", file)
}
g.trustedKeyring = append(g.trustedKeyring, keyring...)
}
}
if len(g.trustedKeyring) == 0 && verbose {
fmt.Printf("\nLooks like your keyring with trusted keys is empty. You might consider importing some keys.\n")
if len(g.keyRingFiles) == 0 {
// using default keyring
fmt.Printf("If you're running Debian or Ubuntu, it's a good idea to import current archive keys by running:\n\n")
fmt.Printf(" gpg --no-default-keyring --keyring /usr/share/keyrings/debian-archive-keyring.gpg --export | gpg --no-default-keyring --keyring trustedkeys.gpg --import\n")
fmt.Printf("\n(for Ubuntu, use /usr/share/keyrings/ubuntu-archive-keyring.gpg)\n\n")
}
}
return nil
}
// AddKeyring adds custom keyrings to the list
func (g *GoVerifier) AddKeyring(keyring string) {
g.keyRingFiles = append(g.keyRingFiles, keyring)
}
func (g *GoVerifier) showImportKeyTip(signers []signatureResult) {
if len(g.keyRingFiles) == 0 {
fmt.Printf("\nLooks like some keys are missing in your trusted keyring, you may consider importing them from keyserver:\n\n")
keys := make([]string, 0)
for _, signer := range signers {
if signer.Entity != nil {
continue
}
keys = append(keys, string(KeyFromUint64(signer.IssuerKeyID)))
}
fmt.Printf("gpg --no-default-keyring --keyring trustedkeys.gpg --keyserver keyserver.ubuntu.com --recv-keys %s\n\n",
strings.Join(keys, " "))
fmt.Printf("Sometimes keys are stored in repository root in file named Release.key, to import such key:\n\n")
fmt.Printf("wget -O - https://some.repo/repository/Release.key | gpg --no-default-keyring --keyring trustedkeys.gpg --import\n\n")
}
}
func (g *GoVerifier) printLog(signers []signatureResult) {
for _, signer := range signers {
fmt.Printf("openpgp: Signature made %s using %s key ID %s\n",
signer.CreationTime.Format(time.RFC1123),
pubkeyAlgorithmName(signer.PubKeyAlgo),
KeyFromUint64(signer.IssuerKeyID))
if signer.Entity != nil {
i := 0
names := make([]string, 0, len(signer.Entity.Identities))
for name := range signer.Entity.Identities {
names = append(names, name)
}
sort.Strings(names)
for _, name := range names {
if i == 0 {
fmt.Printf("openpgp: Good signature from \"%s\"\n", name)
} else {
fmt.Printf(" aka \"%s\"\n", name)
}
i++
}
} else {
fmt.Printf("openpgp: Can't check signature: public key not found\n")
}
}
}
// VerifyDetachedSignature verifies combination of signature and cleartext using gpgv
func (g *GoVerifier) VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error {
var signatureBuf bytes.Buffer
signers, missingKeys, err := checkArmoredDetachedSignature(g.trustedKeyring, cleartext, io.TeeReader(signature, &signatureBuf))
if err == io.EOF {
// most probably not armored signature
signers, missingKeys, err = checkDetachedSignature(g.trustedKeyring, cleartext, &signatureBuf)
}
g.printLog(signers)
if showKeyTip && missingKeys > 0 {
g.showImportKeyTip(signers)
}
if err != nil {
return errors.Wrap(err, "failed to verify detached signature")
}
return nil
}
// IsClearSigned returns true if file contains signature
func (g *GoVerifier) IsClearSigned(clearsigned io.Reader) (bool, error) {
signedBuffer, err := io.ReadAll(clearsigned)
if err != nil {
return false, errors.Wrap(err, "failed to read clearsigned data")
}
block, _ := clearsign.Decode(signedBuffer)
return block != nil, nil
}
// VerifyClearsigned verifies clearsigned file using gpgv
func (g *GoVerifier) VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error) {
signedBuffer, err := io.ReadAll(clearsigned)
if err != nil {
return nil, errors.Wrap(err, "failed to read clearsigned data")
}
block, _ := clearsign.Decode(signedBuffer)
if block == nil {
return nil, errors.New("no clearsigned data found")
}
signers, missingKeys, err := checkDetachedSignature(g.trustedKeyring, bytes.NewBuffer(block.Bytes), block.ArmoredSignature.Body)
g.printLog(signers)
if showKeyTip && missingKeys > 0 {
g.showImportKeyTip(signers)
}
if err != nil {
return nil, errors.Wrap(err, "failed to verify signature")
}
result := &KeyInfo{}
for _, signer := range signers {
if signer.Entity != nil {
result.GoodKeys = append(result.GoodKeys, KeyFromUint64(signer.IssuerKeyID))
} else {
result.MissingKeys = append(result.MissingKeys, KeyFromUint64(signer.IssuerKeyID))
}
}
return result, nil
}
// ExtractClearsigned extracts cleartext from clearsigned file WITHOUT signature verification
func (g *GoVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error) {
var signedBuffer []byte
signedBuffer, err = io.ReadAll(clearsigned)
if err != nil {
return nil, errors.Wrap(err, "failed to read clearsigned data")
}
block, _ := clearsign.Decode(signedBuffer)
if block == nil {
return nil, errors.New("no clearsigned data found")
}
text, err = os.CreateTemp("", "aptly-gpg")
if err != nil {
return
}
defer func() {
_ = os.Remove(text.Name())
}()
_, err = text.Write(block.Bytes)
if err != nil {
return
}
_, err = text.Seek(0, 0)
return
}
var gnupgHome string
func loadKeyRing(name string, ignoreMissing bool) (openpgp.EntityList, error) {
// if path doesn't contain slashes, treat it as relative to GnuPG home directory
if !strings.Contains(name, "/") {
name = filepath.Join(gnupgHome, name)
}
f, err := os.Open(name)
if err != nil {
if os.IsNotExist(err) {
if !ignoreMissing {
fmt.Printf("opengpg: failure opening keyring '%s': %s\n", name, err)
}
return nil, nil
}
return nil, err
}
defer func() {
_ = f.Close()
}()
return openpgp.ReadKeyRing(f)
}
func init() {
gnupgHome = os.Getenv("GNUPGHOME")
if gnupgHome == "" {
// use default location
gnupgHome = filepath.Join(os.Getenv("HOME"), ".gnupg")
}
}
|