github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/engine/pgp_decrypt.go

// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package engine

import (
	"fmt"
	"io"

	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/protocol/keybase1"
)

type PGPDecryptArg struct {
	Source       io.Reader
	Sink         io.WriteCloser
	AssertSigned bool
	SignedBy     string
}

// PGPDecrypt decrypts data read from source into sink for the
// logged in user.
type PGPDecrypt struct {
	libkb.Contextified
	arg        *PGPDecryptArg
	signStatus *libkb.SignatureStatus
	signer     *libkb.User
}

// NewPGPDecrypt creates a PGPDecrypt engine.
func NewPGPDecrypt(g *libkb.GlobalContext, arg *PGPDecryptArg) *PGPDecrypt {
	return &PGPDecrypt{
		arg:          arg,
		Contextified: libkb.NewContextified(g),
	}
}

// Name is the unique engine name.
func (e *PGPDecrypt) Name() string {
	return "PGPDecrypt"
}

// GetPrereqs returns the engine prereqs.
func (e *PGPDecrypt) Prereqs() Prereqs {
	return Prereqs{}
}

// RequiredUIs returns the required UIs.
func (e *PGPDecrypt) RequiredUIs() []libkb.UIKind {
	return []libkb.UIKind{libkb.SecretUIKind, libkb.LogUIKind, libkb.PgpUIKind}
}

// SubConsumers returns the other UI consumers for this engine.
func (e *PGPDecrypt) SubConsumers() []libkb.UIConsumer {
	return []libkb.UIConsumer{
		&ScanKeys{},
		&ResolveThenIdentify2{},
	}
}

// Run starts the engine.
func (e *PGPDecrypt) Run(m libkb.MetaContext) (err error) {
	defer m.Trace("PGPDecrypt#Run", &err)()

	m.Debug("| ScanKeys")
	sk, err := NewScanKeys(m)
	if err != nil {
		return err
	}
	m.Debug("| PGPDecrypt")
	e.signStatus, err = libkb.PGPDecrypt(m.G(), e.arg.Source, e.arg.Sink, sk)
	if err != nil {
		return err
	}

	m.Debug("| Sink Close")
	if err = e.arg.Sink.Close(); err != nil {
		return err
	}

	// get the owner of the signing key
	e.signer = sk.KeyOwner(e.signStatus.KeyID)

	if len(e.arg.SignedBy) > 0 {
		e.arg.AssertSigned = true
	}

	if !e.signStatus.IsSigned {
		if !e.arg.AssertSigned {
			return nil
		}
		return libkb.BadSigError{E: "no signature in message"}
	}
	if !e.signStatus.Verified {
		return e.signStatus.SignatureError
	}

	// message is signed and verified

	// generate sha1 warnings for the key bundles
	if e.signStatus.Entity != nil {
		if warnings := libkb.NewPGPKeyBundle(e.signStatus.Entity).SecurityWarnings(
			libkb.HashSecurityWarningSignersIdentityHash,
		); warnings != nil {
			e.signStatus.Warnings = append(e.signStatus.Warnings, warnings...)
		}
	}

	if len(e.arg.SignedBy) > 0 {
		if e.signer == nil {
			return libkb.BadSigError{
				E: fmt.Sprintf("Signer not a keybase user, cannot match signed by assertion %q", e.arg.SignedBy),
			}
		}

		// identify the SignedBy assertion
		arg := keybase1.Identify2Arg{
			UserAssertion:    e.arg.SignedBy,
			AlwaysBlock:      true,
			NeedProofSet:     true,
			NoSkipSelf:       true,
			IdentifyBehavior: keybase1.TLFIdentifyBehavior_CLI,
		}
		eng := NewResolveThenIdentify2(m.G(), &arg)
		if err := RunEngine2(m, eng); err != nil {
			return err
		}
		res, err := eng.Result(m)
		if err != nil {
			return err
		}
		signByUser := res.Upk

		if !signByUser.GetUID().Equal(e.signer.GetUID()) {
			return libkb.BadSigError{
				E: fmt.Sprintf("Signer %q did not match signed by assertion %q", e.signer.GetName(), e.arg.SignedBy),
			}
		}
	} else {
		if e.signer == nil {
			// signer isn't a keybase user
			m.Debug("message signed by key unknown to keybase: %X", e.signStatus.KeyID)
			if err := OutputSignatureNonKeybase(m, e.signStatus.KeyID, e.signStatus.SignatureTime, e.signStatus.Warnings); err != nil {
				return err
			}
			return libkb.BadSigError{
				E: fmt.Sprintf("Message signed by an unknown key: %X", e.signStatus.KeyID),
			}
		}

		// identify the signer
		arg := keybase1.Identify2Arg{
			UserAssertion:    e.signer.GetName(),
			AlwaysBlock:      true,
			NeedProofSet:     true,
			NoSkipSelf:       true,
			IdentifyBehavior: keybase1.TLFIdentifyBehavior_CLI,
		}
		eng := NewResolveThenIdentify2(m.G(), &arg)
		if err := RunEngine2(m, eng); err != nil {
			return err
		}
	}

	if e.signStatus.Entity == nil {
		return libkb.NoKeyError{Msg: fmt.Sprintf("In signature verification: no public key found for PGP ID %x", e.signStatus.KeyID)}
	}

	if entity := e.signStatus.Entity; len(entity.UnverifiedRevocations) > 0 {
		return libkb.BadSigError{
			E: fmt.Sprintf("Key %x belonging to %q has been revoked by its designated revoker.", entity.PrimaryKey.KeyId, e.signer.GetName()),
		}
	}

	bundle := libkb.NewPGPKeyBundle(e.signStatus.Entity)
	return OutputSignatureSuccess(m, bundle.GetFingerprint(), e.signer, e.signStatus.SignatureTime, e.signStatus.Warnings)
}

func (e *PGPDecrypt) SignatureStatus() *libkb.SignatureStatus {
	return e.signStatus
}

func (e *PGPDecrypt) Signer() *libkb.User {
	return e.signer
}