github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/service/saltpack.go

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

package service

import (
	"archive/zip"
	"bufio"
	"bytes"
	"errors"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"time"

	"github.com/keybase/client/go/chat/attachments/progress"
	"github.com/keybase/client/go/chat/types"
	"github.com/keybase/client/go/engine"
	"github.com/keybase/client/go/libkb"
	keybase1 "github.com/keybase/client/go/protocol/keybase1"
	"github.com/keybase/client/go/saltpackkeys"
	"github.com/keybase/go-framed-msgpack-rpc/rpc"
	"golang.org/x/net/context"
)

const saltpackExtension = ".saltpack"
const encryptedSuffix = ".encrypted"
const signedSuffix = ".signed"
const txtExtension = ".txt"
const zipExtension = ".zip"
const encryptedExtension = encryptedSuffix + saltpackExtension
const signedExtension = signedSuffix + saltpackExtension
const decryptedExtension = ".decrypted"
const verifiedExtension = ".verified"
const encryptedDirSuffix = zipExtension + encryptedSuffix
const signedDirSuffix = zipExtension + signedSuffix

type SaltpackHandler struct {
	*BaseHandler
	libkb.Contextified
}

type RemoteSaltpackUI struct {
	sessionID int
	cli       keybase1.SaltpackUiClient
}

func NewRemoteSaltpackUI(sessionID int, c *rpc.Client) *RemoteSaltpackUI {
	return &RemoteSaltpackUI{
		sessionID: sessionID,
		cli:       keybase1.SaltpackUiClient{Cli: c},
	}
}

func (r *RemoteSaltpackUI) SaltpackPromptForDecrypt(ctx context.Context, arg keybase1.SaltpackPromptForDecryptArg, usedDelegateUI bool) (err error) {
	arg.SessionID = r.sessionID
	arg.UsedDelegateUI = usedDelegateUI
	return r.cli.SaltpackPromptForDecrypt(ctx, arg)
}

func (r *RemoteSaltpackUI) SaltpackVerifySuccess(ctx context.Context, arg keybase1.SaltpackVerifySuccessArg) (err error) {
	arg.SessionID = r.sessionID
	return r.cli.SaltpackVerifySuccess(ctx, arg)
}

func (r *RemoteSaltpackUI) SaltpackVerifyBadSender(ctx context.Context, arg keybase1.SaltpackVerifyBadSenderArg) (err error) {
	arg.SessionID = r.sessionID
	return r.cli.SaltpackVerifyBadSender(ctx, arg)
}

func NewSaltpackHandler(xp rpc.Transporter, g *libkb.GlobalContext) *SaltpackHandler {
	return &SaltpackHandler{
		BaseHandler:  NewBaseHandler(g, xp),
		Contextified: libkb.NewContextified(g),
	}
}

func (h *SaltpackHandler) SaltpackDecrypt(ctx context.Context, arg keybase1.SaltpackDecryptArg) (info keybase1.SaltpackEncryptedMessageInfo, err error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	cli := h.getStreamUICli()
	src := libkb.NewRemoteStreamBuffered(arg.Source, cli, arg.SessionID)
	snk := libkb.NewRemoteStreamBuffered(arg.Sink, cli, arg.SessionID)
	earg := &engine.SaltpackDecryptArg{
		Sink:   snk,
		Source: src,
		Opts:   arg.Opts,
	}

	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(arg.SessionID, h.G()),
		SecretUI:   h.getSecretUI(arg.SessionID, h.G()),
		SaltpackUI: h.getSaltpackUI(arg.SessionID),
		SessionID:  arg.SessionID,
	}
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	resolver := saltpackkeys.NewKeyPseudonymResolver(m)
	eng := engine.NewSaltpackDecrypt(earg, resolver)
	err = engine.RunEngine2(m, eng)
	info = eng.MessageInfo()
	return info, err
}

func (h *SaltpackHandler) SaltpackEncrypt(ctx context.Context, arg keybase1.SaltpackEncryptArg) (keybase1.SaltpackEncryptResult, error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	cli := h.getStreamUICli()
	src := libkb.NewRemoteStreamBuffered(arg.Source, cli, arg.SessionID)
	snk := libkb.NewRemoteStreamBuffered(arg.Sink, cli, arg.SessionID)
	earg := &engine.SaltpackEncryptArg{
		Opts:   arg.Opts,
		Sink:   snk,
		Source: src,
	}

	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(arg.SessionID, h.G()),
		SecretUI:   h.getSecretUI(arg.SessionID, h.G()),
		SessionID:  arg.SessionID,
	}

	keyfinderHook := saltpackkeys.NewRecipientKeyfinderEngineHook(arg.Opts.UseKBFSKeysOnlyForTesting)

	eng := engine.NewSaltpackEncrypt(earg, keyfinderHook)
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	if err := engine.RunEngine2(m, eng); err != nil {
		return keybase1.SaltpackEncryptResult{}, err
	}

	return keybase1.SaltpackEncryptResult{
		UsedUnresolvedSBS:      eng.UsedSBS,
		UnresolvedSBSAssertion: eng.SBSAssertion,
	}, nil
}

func (h *SaltpackHandler) SaltpackSign(ctx context.Context, arg keybase1.SaltpackSignArg) error {
	ctx = libkb.WithLogTag(ctx, "SP")
	cli := h.getStreamUICli()
	src := libkb.NewRemoteStreamBuffered(arg.Source, cli, arg.SessionID)
	snk := libkb.NewRemoteStreamBuffered(arg.Sink, cli, arg.SessionID)
	earg := &engine.SaltpackSignArg{
		Opts:   arg.Opts,
		Sink:   snk,
		Source: src,
	}

	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(arg.SessionID, h.G()),
		SecretUI:   h.getSecretUI(arg.SessionID, h.G()),
		SessionID:  arg.SessionID,
	}
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	eng := engine.NewSaltpackSign(h.G(), earg)
	return engine.RunEngine2(m, eng)
}

func (h *SaltpackHandler) SaltpackVerify(ctx context.Context, arg keybase1.SaltpackVerifyArg) error {
	ctx = libkb.WithLogTag(ctx, "SP")
	cli := h.getStreamUICli()
	src := libkb.NewRemoteStreamBuffered(arg.Source, cli, arg.SessionID)
	snk := libkb.NewRemoteStreamBuffered(arg.Sink, cli, arg.SessionID)
	earg := &engine.SaltpackVerifyArg{
		Opts:   arg.Opts,
		Sink:   snk,
		Source: src,
	}

	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(arg.SessionID, h.G()),
		SecretUI:   h.getSecretUI(arg.SessionID, h.G()),
		SaltpackUI: h.getSaltpackUI(arg.SessionID),
		SessionID:  arg.SessionID,
	}
	eng := engine.NewSaltpackVerify(h.G(), earg)
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	return engine.RunEngine2(m, eng)
}

// frontend handlers:

func (h *SaltpackHandler) SaltpackEncryptString(ctx context.Context, arg keybase1.SaltpackEncryptStringArg) (keybase1.SaltpackEncryptStringResult, error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	eopts := h.encryptOptions(arg.Opts)
	eopts.NoForcePoll = true
	return h.encryptString(ctx, arg.SessionID, arg.Plaintext, eopts)
}

func (h *SaltpackHandler) SaltpackEncryptStringToTextFile(ctx context.Context, arg keybase1.SaltpackEncryptStringToTextFileArg) (r keybase1.SaltpackEncryptFileResult, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	eopts := h.encryptOptions(arg.Opts)
	res, err := h.encryptString(ctx, arg.SessionID, arg.Plaintext, eopts)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}
	filename, err := h.writeStringToFile(ctx, res.Ciphertext, encryptedExtension)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}
	fres := keybase1.SaltpackEncryptFileResult{
		UsedUnresolvedSBS:      res.UsedUnresolvedSBS,
		UnresolvedSBSAssertion: res.UnresolvedSBSAssertion,
		Filename:               filename,
	}
	return fres, nil
}

func (h *SaltpackHandler) encryptString(ctx context.Context, sessionID int, plaintext string, eopts keybase1.SaltpackEncryptOptions) (keybase1.SaltpackEncryptStringResult, error) {
	sink := libkb.NewBufferCloser()
	earg := &engine.SaltpackEncryptArg{
		Opts:   eopts,
		Sink:   sink,
		Source: strings.NewReader(plaintext),
	}

	usedSBS, assertion, err := h.frontendEncrypt(ctx, sessionID, earg)
	if err != nil {
		return keybase1.SaltpackEncryptStringResult{}, err
	}

	return keybase1.SaltpackEncryptStringResult{
		UsedUnresolvedSBS:      usedSBS,
		UnresolvedSBSAssertion: assertion,
		Ciphertext:             sink.String(),
	}, nil
}

func (h *SaltpackHandler) SaltpackDecryptString(ctx context.Context, arg keybase1.SaltpackDecryptStringArg) (keybase1.SaltpackPlaintextResult, error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	sink := libkb.NewBufferCloser()
	earg := &engine.SaltpackDecryptArg{
		Sink:   sink,
		Source: strings.NewReader(arg.Ciphertext),
	}

	info, signed, err := h.frontendDecrypt(ctx, arg.SessionID, earg)
	if err != nil {
		return keybase1.SaltpackPlaintextResult{}, err
	}
	r := keybase1.SaltpackPlaintextResult{
		Info:      info,
		Plaintext: sink.String(),
		Signed:    signed,
	}
	return r, nil
}

func (h *SaltpackHandler) SaltpackSignString(ctx context.Context, arg keybase1.SaltpackSignStringArg) (string, error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	return h.signString(ctx, arg.SessionID, arg.Plaintext)
}

func (h *SaltpackHandler) SaltpackSignStringToTextFile(ctx context.Context, arg keybase1.SaltpackSignStringToTextFileArg) (s string, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	signed, err := h.signString(ctx, arg.SessionID, arg.Plaintext)
	if err != nil {
		return "", err
	}

	return h.writeStringToFile(ctx, signed, signedExtension)
}

func (h *SaltpackHandler) signString(ctx context.Context, sessionID int, plaintext string) (string, error) {
	sink := libkb.NewBufferCloser()
	earg := &engine.SaltpackSignArg{
		Sink:   sink,
		Source: io.NopCloser(bytes.NewBufferString(plaintext)),
	}

	if err := h.frontendSign(ctx, sessionID, earg); err != nil {
		return "", err
	}

	return sink.String(), nil
}

func (h *SaltpackHandler) SaltpackVerifyString(ctx context.Context, arg keybase1.SaltpackVerifyStringArg) (keybase1.SaltpackVerifyResult, error) {
	ctx = libkb.WithLogTag(ctx, "SP")
	sink := libkb.NewBufferCloser()
	earg := &engine.SaltpackVerifyArg{
		Sink:   sink,
		Source: strings.NewReader(arg.SignedMsg),
	}

	spui, err := h.frontendVerify(ctx, arg.SessionID, earg)
	if err != nil {
		return keybase1.SaltpackVerifyResult{}, err
	}
	res := keybase1.SaltpackVerifyResult{
		Plaintext: sink.String(),
		Verified:  spui.verified,
	}
	if spui.signingKID != nil {
		res.SigningKID = *spui.signingKID
	}
	if spui.sender != nil {
		res.Sender = *spui.sender
	}
	return res, nil
}

func (h *SaltpackHandler) SaltpackEncryptFile(ctx context.Context, arg keybase1.SaltpackEncryptFileArg) (r keybase1.SaltpackEncryptFileResult, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	dir, err := isDir(arg.Filename)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}

	if dir {
		return h.saltpackEncryptDirectory(ctx, arg)
	}
	return h.saltpackEncryptFile(ctx, arg)
}

func (h *SaltpackHandler) saltpackEncryptFile(ctx context.Context, arg keybase1.SaltpackEncryptFileArg) (keybase1.SaltpackEncryptFileResult, error) {
	sf, err := newSourceFile(h.G(), keybase1.SaltpackOperationType_ENCRYPT, arg.Filename)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}
	defer sf.Close()

	outFilename, bw, err := boxFilename(arg.Filename, encryptedSuffix, arg.DestinationDir)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}
	defer bw.Close()

	opts := h.encryptOptions(arg.Opts)
	opts.Binary = true
	opts.UseDeviceKeys = true

	earg := &engine.SaltpackEncryptArg{
		Opts:   opts,
		Sink:   bw,
		Source: sf,
	}

	usedSBS, assertion, err := h.frontendEncrypt(ctx, arg.SessionID, earg)
	if err != nil {
		h.G().Log.Debug("encrypt error, so removing output file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return keybase1.SaltpackEncryptFileResult{}, err
	}

	return keybase1.SaltpackEncryptFileResult{
		UsedUnresolvedSBS:      usedSBS,
		UnresolvedSBSAssertion: assertion,
		Filename:               outFilename,
	}, nil
}

func (h *SaltpackHandler) saltpackEncryptDirectory(ctx context.Context, arg keybase1.SaltpackEncryptFileArg) (keybase1.SaltpackEncryptFileResult, error) {
	h.G().Log.Debug("encrypting directory")

	if filepath.Clean(arg.Filename) == filepath.Clean(arg.DestinationDir) {
		return keybase1.SaltpackEncryptFileResult{}, errors.New("source and destination directories cannot be the same")
	}

	h.G().NotifyRouter.HandleSaltpackOperationStart(ctx, keybase1.SaltpackOperationType_ENCRYPT, arg.Filename)
	defer h.G().NotifyRouter.HandleSaltpackOperationDone(ctx, keybase1.SaltpackOperationType_ENCRYPT, arg.Filename)

	progReporter := func(bytesComplete, bytesTotal int64) {
		h.G().NotifyRouter.HandleSaltpackOperationProgress(ctx, keybase1.SaltpackOperationType_ENCRYPT, arg.Filename, bytesComplete, bytesTotal)
	}
	prog, err := newDirProgressWriter(progReporter, arg.Filename)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}

	pipeRead := zipDir(arg.Filename, prog)

	outFilename, bw, err := boxFilename(arg.Filename, encryptedDirSuffix, arg.DestinationDir)
	if err != nil {
		return keybase1.SaltpackEncryptFileResult{}, err
	}
	defer bw.Close()

	opts := h.encryptOptions(arg.Opts)
	opts.Binary = true
	opts.UseDeviceKeys = true

	earg := &engine.SaltpackEncryptArg{
		Opts:   opts,
		Sink:   bw,
		Source: pipeRead,
	}

	usedSBS, assertion, err := h.frontendEncrypt(ctx, arg.SessionID, earg)
	if err != nil {
		h.G().Log.Debug("encrypt error, so removing output file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return keybase1.SaltpackEncryptFileResult{}, err
	}

	return keybase1.SaltpackEncryptFileResult{
		UsedUnresolvedSBS:      usedSBS,
		UnresolvedSBSAssertion: assertion,
		Filename:               outFilename,
	}, nil
}

func (h *SaltpackHandler) SaltpackDecryptFile(ctx context.Context, arg keybase1.SaltpackDecryptFileArg) (r keybase1.SaltpackFileResult, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	sf, err := newSourceFile(h.G(), keybase1.SaltpackOperationType_DECRYPT, arg.EncryptedFilename)
	if err != nil {
		return keybase1.SaltpackFileResult{}, err
	}
	defer sf.Close()

	outFilename, bw, err := unboxFilename(arg.EncryptedFilename, decryptedExtension, arg.DestinationDir)
	if err != nil {
		return keybase1.SaltpackFileResult{}, err
	}
	defer bw.Close()

	earg := &engine.SaltpackDecryptArg{
		Sink:   bw,
		Source: sf,
	}

	info, signed, err := h.frontendDecrypt(ctx, arg.SessionID, earg)
	if err != nil {
		h.G().Log.Debug("decrypt error, so removing output file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return keybase1.SaltpackFileResult{}, err
	}

	r = keybase1.SaltpackFileResult{
		Info:              info,
		DecryptedFilename: outFilename,
		Signed:            signed,
	}
	return r, nil
}

func (h *SaltpackHandler) SaltpackSignFile(ctx context.Context, arg keybase1.SaltpackSignFileArg) (s string, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	dir, err := isDir(arg.Filename)
	if err != nil {
		return "", err
	}

	if dir {
		return h.saltpackSignDirectory(ctx, arg)
	}
	return h.saltpackSignFile(ctx, arg)
}

func (h *SaltpackHandler) saltpackSignFile(ctx context.Context, arg keybase1.SaltpackSignFileArg) (string, error) {
	sf, err := newSourceFile(h.G(), keybase1.SaltpackOperationType_SIGN, arg.Filename)
	if err != nil {
		return "", err
	}
	defer sf.Close()

	outFilename, bw, err := boxFilename(arg.Filename, signedSuffix, arg.DestinationDir)
	if err != nil {
		return "", err
	}
	defer bw.Close()

	earg := &engine.SaltpackSignArg{
		Sink:   bw,
		Source: sf,
		Opts: keybase1.SaltpackSignOptions{
			Binary: true,
		},
	}

	if err := h.frontendSign(ctx, arg.SessionID, earg); err != nil {
		h.G().Log.Debug("sign error, so removing output file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return "", err
	}

	return outFilename, nil
}

func (h *SaltpackHandler) saltpackSignDirectory(ctx context.Context, arg keybase1.SaltpackSignFileArg) (string, error) {
	h.G().Log.Debug("signing directory")

	if filepath.Clean(arg.Filename) == filepath.Clean(arg.DestinationDir) {
		return "", errors.New("source and destination directories cannot be the same")
	}

	h.G().NotifyRouter.HandleSaltpackOperationStart(ctx, keybase1.SaltpackOperationType_SIGN, arg.Filename)
	defer h.G().NotifyRouter.HandleSaltpackOperationDone(ctx, keybase1.SaltpackOperationType_ENCRYPT, arg.Filename)

	progReporter := func(bytesComplete, bytesTotal int64) {
		h.G().NotifyRouter.HandleSaltpackOperationProgress(ctx, keybase1.SaltpackOperationType_SIGN, arg.Filename, bytesComplete, bytesTotal)
	}

	prog, err := newDirProgressWriter(progReporter, arg.Filename)
	if err != nil {
		return "", err
	}

	pipeRead := zipDir(arg.Filename, prog)

	outFilename, bw, err := boxFilename(arg.Filename, signedDirSuffix, arg.DestinationDir)
	if err != nil {
		return "", err
	}
	defer bw.Close()

	earg := &engine.SaltpackSignArg{
		Sink:   bw,
		Source: pipeRead,
		Opts: keybase1.SaltpackSignOptions{
			Binary: true,
		},
	}

	if err := h.frontendSign(ctx, arg.SessionID, earg); err != nil {
		h.G().Log.Debug("sign error, so removing output file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return "", err
	}

	return outFilename, nil
}

func (h *SaltpackHandler) SaltpackVerifyFile(ctx context.Context, arg keybase1.SaltpackVerifyFileArg) (r keybase1.SaltpackVerifyFileResult, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	sf, err := newSourceFile(h.G(), keybase1.SaltpackOperationType_VERIFY, arg.SignedFilename)
	if err != nil {
		return keybase1.SaltpackVerifyFileResult{}, err
	}
	defer sf.Close()

	outFilename, bw, err := unboxFilename(arg.SignedFilename, verifiedExtension, arg.DestinationDir)
	if err != nil {
		return keybase1.SaltpackVerifyFileResult{}, err
	}
	defer bw.Close()

	earg := &engine.SaltpackVerifyArg{
		Sink:   bw,
		Source: sf,
	}

	spui, err := h.frontendVerify(ctx, arg.SessionID, earg)
	if err != nil {
		h.G().Log.Debug("verify error, so removing ouput file")
		if clErr := bw.Close(); clErr != nil {
			transformSaltpackError(&clErr)
			h.G().Log.Debug("error closing bw for output file: %s", clErr)
		}
		if rmErr := os.Remove(outFilename); rmErr != nil {
			transformSaltpackError(&rmErr)
			h.G().Log.Debug("error removing output file: %s", rmErr)
		}
		return keybase1.SaltpackVerifyFileResult{}, err
	}
	res := keybase1.SaltpackVerifyFileResult{
		VerifiedFilename: outFilename,
		Verified:         spui.verified,
	}
	if spui.signingKID != nil {
		res.SigningKID = *spui.signingKID
	}
	if spui.sender != nil {
		res.Sender = *spui.sender
	}
	return res, nil
}

func (h *SaltpackHandler) SaltpackSaveCiphertextToFile(ctx context.Context, arg keybase1.SaltpackSaveCiphertextToFileArg) (s string, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	return h.writeStringToFile(ctx, arg.Ciphertext, txtExtension+encryptedExtension)
}

func (h *SaltpackHandler) SaltpackSaveSignedMsgToFile(ctx context.Context, arg keybase1.SaltpackSaveSignedMsgToFileArg) (s string, err error) {
	defer transformSaltpackError(&err)
	ctx = libkb.WithLogTag(ctx, "SP")
	return h.writeStringToFile(ctx, arg.SignedMsg, txtExtension+signedExtension)
}

func (h *SaltpackHandler) encryptOptions(opts keybase1.SaltpackFrontendEncryptOptions) keybase1.SaltpackEncryptOptions {
	auth := keybase1.AuthenticityType_REPUDIABLE
	if opts.Signed {
		auth = keybase1.AuthenticityType_SIGNED
	}
	return keybase1.SaltpackEncryptOptions{
		Recipients:       opts.Recipients,
		AuthenticityType: auth,
		NoSelfEncrypt:    !opts.IncludeSelf,
		UseEntityKeys:    true,
		UsePaperKeys:     true,
	}
}

func (h *SaltpackHandler) frontendEncrypt(ctx context.Context, sessionID int, arg *engine.SaltpackEncryptArg) (bool, string, error) {
	uis := libkb.UIs{
		SecretUI:  &nopSecretUI{},
		SessionID: sessionID,
	}

	keyfinderHook := saltpackkeys.NewRecipientKeyfinderEngineHook(false)

	eng := engine.NewSaltpackEncrypt(arg, keyfinderHook)
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)

	err := engine.RunEngine2(m, eng)
	return eng.UsedSBS, eng.SBSAssertion, err
}

func (h *SaltpackHandler) frontendDecrypt(ctx context.Context, sessionID int, arg *engine.SaltpackDecryptArg) (keybase1.SaltpackEncryptedMessageInfo, bool, error) {
	spui := &capSaltpackUI{}
	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(sessionID, h.G()),
		SecretUI:   &nopSecretUI{},
		SaltpackUI: spui,
		SessionID:  sessionID,
	}
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	resolver := saltpackkeys.NewKeyPseudonymResolver(m)
	eng := engine.NewSaltpackDecrypt(arg, resolver)
	if err := engine.RunEngine2(m, eng); err != nil {
		return keybase1.SaltpackEncryptedMessageInfo{}, false, err
	}
	return eng.MessageInfo(), spui.verified, nil
}

func (h *SaltpackHandler) frontendVerify(ctx context.Context, sessionID int, arg *engine.SaltpackVerifyArg) (*capSaltpackUI, error) {
	spui := &capSaltpackUI{}
	uis := libkb.UIs{
		IdentifyUI: h.NewRemoteIdentifyUI(sessionID, h.G()),
		SecretUI:   &nopSecretUI{},
		SaltpackUI: spui,
		SessionID:  sessionID,
	}
	eng := engine.NewSaltpackVerify(h.G(), arg)
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	if err := engine.RunEngine2(m, eng); err != nil {
		return nil, err
	}
	return spui, nil
}

func (h *SaltpackHandler) frontendSign(ctx context.Context, sessionID int, arg *engine.SaltpackSignArg) error {
	uis := libkb.UIs{
		SecretUI:  &nopSecretUI{},
		SessionID: sessionID,
	}
	m := libkb.NewMetaContext(ctx, h.G()).WithUIs(uis)
	eng := engine.NewSaltpackSign(h.G(), arg)
	return engine.RunEngine2(m, eng)
}

func boxFilename(inFilename, suffix, destinationDir string) (string, *libkb.BufferWriter, error) {
	dir, file := filepath.Split(inFilename)
	if destinationDir != "" {
		dir = destinationDir
	}
	withExt := filepath.Join(dir, file+suffix+saltpackExtension)
	f, err := os.Create(withExt)
	if err != nil {
		return "", nil, err
	}
	return withExt, libkb.NewBufferWriter(f), nil
}

// unboxFilename takes a filename and creates a new file where the result
// of decrypt or verify can go.
//
// If inFilename ends in .encrypted.saltpack or .signed.saltpack, the result
// filename will just have that stripped off.  If a file without that extension
// already exists, it will look for a file with <name>` (n)`.<extension> for
// n = 1..99 that doesn't exist.
//
// If inFilename doesn't have a saltpack suffix, it uses the suffix that is passed
// in, so it would be <filename>.decrypted or <filename>.verified.
//
// If destinationDir is empty, it will use the directory of inFilename.
func unboxFilename(inFilename, suffix, destinationDir string) (string, *libkb.BufferWriter, error) {
	dir, file := filepath.Split(inFilename)
	if destinationDir != "" {
		dir = destinationDir
	}
	// default desired filename is the input filename plus the suffix.
	desiredFilename := file + suffix

	// if the input filename ends in .encrypted.saltpack or .signed.saltpack,
	// strip that off and use that instead.
	if strings.HasSuffix(file, encryptedExtension) {
		desiredFilename = strings.TrimSuffix(file, encryptedExtension)
	} else if strings.HasSuffix(file, signedExtension) {
		desiredFilename = strings.TrimSuffix(file, signedExtension)
	}

	finalPath := filepath.Join(dir, desiredFilename)

	var found bool
	for i := 0; i < 100; i++ {
		possible := finalPath
		if i > 0 {
			// after the first time through, add a (i) to the filename
			// to try to find one that doesn't exist
			ext := filepath.Ext(possible)
			possible = fmt.Sprintf("%s (%d)%s", strings.TrimSuffix(possible, ext), i, ext)
		}
		exists, err := libkb.FileExists(possible)
		if err != nil {
			return "", nil, err
		}
		if !exists {
			// found a filename that doesn't exist
			found = true
			finalPath = possible
			break
		}
	}

	if !found {
		// after 100 attempts, no file found that wouldn't overwrite an existing
		// file, so bail out.
		return "", nil, errors.New("could not create output file without overwriting existing file")
	}

	// finalPath contains a filename that doesn't exist, so make the file
	f, err := os.Create(finalPath)
	if err != nil {
		return "", nil, err
	}
	return finalPath, libkb.NewBufferWriter(f), nil
}

func (h *SaltpackHandler) writeStringToFile(ctx context.Context, contents, suffix string) (filename string, err error) {
	dir := h.G().Env.GetDownloadsDir()
	if err := os.MkdirAll(dir, libkb.PermDir); err != nil {
		return "", err
	}
	tmpfile, err := os.CreateTemp(dir, "keybase_*"+suffix)
	if err != nil {
		return "", err
	}
	if _, err = tmpfile.Write([]byte(contents)); err != nil {
		_ = tmpfile.Close()
		return "", err
	}
	if err := tmpfile.Close(); err != nil {
		return "", err
	}

	return tmpfile.Name(), nil
}

// nopSecretUI returns an error if it is ever called.
// A lot of these saltpack engines say they require a secret UI.
// They really don't, but it's dangerous to try to strip it out.
type nopSecretUI struct{}

func (n *nopSecretUI) GetPassphrase(pinentry keybase1.GUIEntryArg, terminal *keybase1.SecretEntryArg) (keybase1.GetPassphraseRes, error) {
	return keybase1.GetPassphraseRes{}, errors.New("GetPassphrase called unexpectedly")
}

// capSaltpackUI captures the various sender info so the RPCs can just return that
// directly to the caller instead of via a UI.
type capSaltpackUI struct {
	decryptArg *keybase1.SaltpackPromptForDecryptArg
	signingKID *keybase1.KID
	sender     *keybase1.SaltpackSender
	verified   bool
}

func (c *capSaltpackUI) SaltpackPromptForDecrypt(ctx context.Context, arg keybase1.SaltpackPromptForDecryptArg, _ bool) error {
	c.decryptArg = &arg
	c.verified = arg.Signed
	return nil
}

func (c *capSaltpackUI) SaltpackVerifySuccess(ctx context.Context, arg keybase1.SaltpackVerifySuccessArg) error {
	c.signingKID = &arg.SigningKID
	c.sender = &arg.Sender
	c.verified = true
	return nil
}

func (c *capSaltpackUI) SaltpackVerifyBadSender(ctx context.Context, arg keybase1.SaltpackVerifyBadSenderArg) error {
	c.signingKID = &arg.SigningKID
	c.sender = &arg.Sender
	c.verified = false
	return nil
}

type sourceFile struct {
	filename string
	op       keybase1.SaltpackOperationType
	f        *os.File
	r        io.Reader
	prog     *progress.ProgressWriter
	libkb.Contextified
}

func newSourceFile(g *libkb.GlobalContext, op keybase1.SaltpackOperationType, filename string) (*sourceFile, error) {
	s, err := os.Stat(filename)
	if err != nil {
		return nil, err
	}
	f, err := os.Open(filename)
	if err != nil {
		return nil, err
	}
	sf := &sourceFile{
		filename:     filename,
		op:           op,
		f:            f,
		Contextified: libkb.NewContextified(g),
	}
	sf.G().NotifyRouter.HandleSaltpackOperationStart(context.Background(), sf.op, sf.filename)
	sf.prog = progress.NewProgressWriterWithUpdateDuration(sf.reporter, s.Size(), 80*time.Millisecond)
	sf.r = io.TeeReader(bufio.NewReader(f), sf.prog)
	return sf, nil
}

func (sf *sourceFile) Read(p []byte) (n int, err error) {
	return sf.r.Read(p)
}

func (sf *sourceFile) Close() error {
	sf.G().NotifyRouter.HandleSaltpackOperationDone(context.Background(), sf.op, sf.filename)
	sf.prog.Finish()
	return sf.f.Close()
}

func (sf *sourceFile) reporter(bytesComplete, bytesTotal int64) {
	sf.G().NotifyRouter.HandleSaltpackOperationProgress(context.Background(), sf.op, sf.filename, bytesComplete, bytesTotal)
}

func isDir(filename string) (bool, error) {
	s, err := os.Stat(filename)
	if err != nil {
		return false, err
	}
	return s.IsDir(), nil
}

func dirTotalSize(filename string) (int64, error) {
	var total int64
	err := filepath.Walk(filename, func(path string, info os.FileInfo, inErr error) error {
		if inErr != nil {
			return inErr
		}
		if info.IsDir() {
			return nil
		}
		total += info.Size()
		return nil
	})
	return total, err
}

// zipDir will create a zip archive of everything in directory suitablie for streaming.
// Read the data of the zip archive from the returned io.ReadCloser.
func zipDir(directory string, prog *progress.ProgressWriter) io.ReadCloser {
	// make a pipe so we can give saltpack engines a reader for the zip source
	pipeRead, pipeWrite := io.Pipe()

	// connect a zip archiver to the writer side of the pipe
	w := zip.NewWriter(pipeWrite)

	// given a directory like "a/b/c/d" or "/opt/blah/d", we want the files in the
	// zip file to recreate just the final directory.  In other words, d/, d/1/, d/1/000.log
	// and *not* a/b/c/d/, a/b/c/d/1/, a/b/c/d/1/000.log.
	parent := filepath.Dir(directory)
	stripParent := func(s string) string {
		return strings.TrimPrefix(s, parent+string(filepath.Separator))
	}

	go func() {
		err := filepath.Walk(directory, func(path string, info os.FileInfo, inErr error) (outErr error) {
			defer transformSaltpackError(&outErr)
			if inErr != nil {
				return inErr
			}

			stripped := stripParent(path)

			header, err := zip.FileInfoHeader(info)
			if err != nil {
				return err
			}
			header.Method = zip.Deflate

			if info.IsDir() {
				// make a directory by calling Create with a filename ending in a separator.
				header.Name = stripped + string(filepath.Separator)
				_, err := w.CreateHeader(header)
				if err != nil {
					return err
				}
				return nil
			}

			if (info.Mode() & os.ModeSymlink) != 0 {
				// figure out the destination of the link
				dest, err := os.Readlink(path)
				if err != nil {
					return err
				}
				header.Name = stripped
				zw, err := w.CreateHeader(header)
				if err != nil {
					return err
				}
				// the body of the entry is the link destination
				_, err = zw.Write([]byte(dest))
				if err != nil {
					return err
				}
				return nil
			}

			// make a regular file and copy all the data into it.
			header.Name = stripped
			zw, err := w.CreateHeader(header)
			if err != nil {
				return err
			}
			f, err := os.Open(path)
			if err != nil {
				return err
			}
			defer f.Close()
			tr := io.TeeReader(bufio.NewReader(f), prog)
			_, err = io.Copy(zw, tr)
			if err != nil {
				return err
			}

			return nil
		})

		// close everything
		closeErr := w.Close()
		if closeErr != nil && err == nil {
			err = closeErr
		}
		_ = pipeWrite.CloseWithError(err)
	}()

	return pipeRead
}

func newDirProgressWriter(p types.ProgressReporter, dir string) (*progress.ProgressWriter, error) {
	// for progress purposes, we need to know total size of everything in the directory
	size, err := dirTotalSize(dir)
	if err != nil {
		return nil, err
	}

	return progress.NewProgressWriterWithUpdateDuration(p, size, 80*time.Millisecond), nil
}

func transformSaltpackError(err *error) {
	if err == nil {
		return
	}
	if *err == nil {
		return
	}

	switch e := (*err).(type) {
	case *os.PathError:
		// this should remove the path from the error
		*err = e.Unwrap()
	default:
		// golangci-lint/gocritic, you really drive me crazy sometimes...
	}
}