[feat] Replace clipboard library to support wl-copy args (gopasspw#3123)

* [feat] Replace clipboard library to support wl-copy args

This change should allow us to protect sensitive content
from being captured in some clipboard managers on KDE.

Fixes gopasspw#2611

Signed-off-by: Dominik Schulz <[email protected]>

* [chore] Update clipboard dep

Signed-off-by: Dominik Schulz <[email protected]>

* [fix] Update clipboard

Signed-off-by: Dominik Schulz <[email protected]>

---------

Signed-off-by: Dominik Schulz <[email protected]>

Author: dominikschulz

go.mod

@@ -1,11 +1,10 @@
 module github.com/gopasspw/gopass
 
-go 1.24.0
+go 1.24.1
 
 require (
 	filippo.io/age v1.2.1-0.20240618131852-7eedd929a6cf
 	github.com/ProtonMail/go-crypto v1.2.0
-	github.com/atotto/clipboard v0.1.4
 	github.com/blang/semver/v4 v4.0.0
 	github.com/caspr-io/yamlpath v0.0.0-20200722075116-502e8d113a9b
 	github.com/cenkalti/backoff/v4 v4.3.0
@@ -16,6 +15,7 @@ require (
 	github.com/gokyle/twofactor v1.0.1
 	github.com/google/go-cmp v0.7.0
 	github.com/google/go-github/v61 v61.0.0
+	github.com/gopasspw/clipboard v0.0.0-20250418184741-a9895c5a47ee
 	github.com/gopasspw/gopass-hibp v1.15.15
 	github.com/hashicorp/golang-lru/v2 v2.0.7
 	github.com/jsimonetti/pwscheme v0.0.0-20220922140336-67a4d090f150
@@ -52,6 +52,7 @@ require (
 	al.essio.dev/pkg/shellescape v1.6.0 // indirect
 	codeberg.org/tslocum/cbind v0.1.6 // indirect
 	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/atotto/clipboard v0.1.4 // indirect
 	github.com/boombuler/barcode v1.0.2 // indirect
 	github.com/cloudflare/circl v1.6.1 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect

go.sum

@@ -71,6 +71,14 @@ github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
+github.com/gopasspw/clipboard v0.0.0-20250417190150-d64f7d604636 h1:IqhPR3G2C1cdMgKKHYwaASJuh9meJDy6Abes44nYxTQ=
+github.com/gopasspw/clipboard v0.0.0-20250417190150-d64f7d604636/go.mod h1:b2ka158TfIu6UEYbnuYGjztg9dNwAIwCBL3qNoKH8qE=
+github.com/gopasspw/clipboard v0.0.0-20250418164705-c6bd724b45e0 h1:xCvVD0/DfFzYybu1t/dkLwXWwGPQdrfHvQSRtFJKhC8=
+github.com/gopasspw/clipboard v0.0.0-20250418164705-c6bd724b45e0/go.mod h1:i0cShr7JEbOXZ/iKM5RyfBLbu1FPzouO8BTCJy0uHy8=
+github.com/gopasspw/clipboard v0.0.0-20250418174641-ec5f8eb4a01b h1:wMbrBbxjh/cZeqXGTGhYs4L65tP6YBKvIgDTo9RIv94=
+github.com/gopasspw/clipboard v0.0.0-20250418174641-ec5f8eb4a01b/go.mod h1:i0cShr7JEbOXZ/iKM5RyfBLbu1FPzouO8BTCJy0uHy8=
+github.com/gopasspw/clipboard v0.0.0-20250418184741-a9895c5a47ee h1:I1bYhCNc3Qbd/sbjFPFZfeKmNvC+wIuFhwzCDmnBaX8=
+github.com/gopasspw/clipboard v0.0.0-20250418184741-a9895c5a47ee/go.mod h1:i0cShr7JEbOXZ/iKM5RyfBLbu1FPzouO8BTCJy0uHy8=
 github.com/gopasspw/gopass-hibp v1.15.15 h1:zmLhxXKu3fLa7qAexKw4EWVfKGgFzJ1j5ra9nzNnd1Y=
 github.com/gopasspw/gopass-hibp v1.15.15/go.mod h1:7xE84pJnO6x3i+u38NeUAvYlJVYPTUNL3Y5XJHSAwaY=
 github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=

internal/action/create_test.go

@@ -5,7 +5,7 @@ import (
 	"os"
 	"testing"
 
-	aclip "github.com/atotto/clipboard"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/config"
 	"github.com/gopasspw/gopass/internal/out"
 	"github.com/gopasspw/gopass/pkg/ctxutil"
@@ -16,7 +16,7 @@ import (
 func TestCreate(t *testing.T) {
 	u := gptest.NewUnitTester(t)
 
-	aclip.Unsupported = true
+	clipboard.ForceUnsupported = true
 
 	ctx := config.NewContextInMemory()
 	ctx = ctxutil.WithAlwaysYes(ctx, true)

internal/action/show_test.go

@@ -6,8 +6,8 @@ import (
 	"os"
 	"testing"
 
-	"github.com/atotto/clipboard"
 	"github.com/fatih/color"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/config"
 	"github.com/gopasspw/gopass/internal/out"
 	"github.com/gopasspw/gopass/pkg/ctxutil"
@@ -224,11 +224,11 @@ func TestShowMulti(t *testing.T) {
 
 func TestShowAutoClip(t *testing.T) {
 	// make sure we consistently get the unsupported error message
-	ov := clipboard.Unsupported
+	ov := clipboard.ForceUnsupported
 	defer func() {
-		clipboard.Unsupported = ov
+		clipboard.ForceUnsupported = ov
 	}()
-	clipboard.Unsupported = true
+	clipboard.ForceUnsupported = true
 
 	u := gptest.NewUnitTester(t)
 

main_test.go

@@ -8,9 +8,9 @@ import (
 	"runtime"
 	"testing"
 
-	"github.com/atotto/clipboard"
 	"github.com/blang/semver/v4"
 	"github.com/fatih/color"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/action"
 	"github.com/gopasspw/gopass/internal/backend"
 	"github.com/gopasspw/gopass/internal/backend/crypto/gpg"
@@ -118,7 +118,7 @@ func TestGetCommands(t *testing.T) {
 	cfg := config.NewInMemory()
 	require.NoError(t, cfg.SetPath(u.StoreDir("")))
 
-	clipboard.Unsupported = true
+	clipboard.ForceUnsupported = true
 
 	ctx := config.NewContextInMemory()
 	ctx = ctxutil.WithAlwaysYes(ctx, true)

pkg/clipboard/clipboard.go

@@ -7,8 +7,8 @@ import (
 	"os"
 	"os/exec"
 
-	"github.com/atotto/clipboard"
 	"github.com/fatih/color"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/notify"
 	"github.com/gopasspw/gopass/internal/out"
 	"github.com/gopasspw/gopass/pkg/debug"
@@ -17,7 +17,7 @@ import (
 var (
 	// Helpers can be overridden at compile time, e.g. go build \
 	// -ldflags=='-X github.com/gopasspw/gopass/pkg/clipboard.Helpers=termux-api'.
-	Helpers = "xsel or xclip"
+	Helpers = "xsel, xclip or wl-clipboard"
 	// ErrNotSupported is returned when the clipboard is not accessible.
 	ErrNotSupported = fmt.Errorf("WARNING: No clipboard available. "+
 		"Install %s, provide $GOPASS_CLIPBOARD_COPY_CMD and $GOPASS_CLIPBOARD_CLEAR_CMD or use -f to print to console", Helpers)
@@ -35,7 +35,7 @@ func CopyTo(ctx context.Context, name string, content []byte, timeout int) error
 
 			return fmt.Errorf("failed to call clipboard copy command: %w", err)
 		}
-	} else if clipboard.Unsupported {
+	} else if clipboard.IsUnsupported() {
 		out.Errorf(ctx, "%s", ErrNotSupported)
 		_ = notify.Notify(ctx, "gopass - clipboard", ErrNotSupported.Error())
 
@@ -67,7 +67,15 @@ func CopyTo(ctx context.Context, name string, content []byte, timeout int) error
 	return nil
 }
 
-func callCommand(ctx context.Context, cmd string, parameter string, stdinValue []byte) error {
+func copyToClipboard(ctx context.Context, content []byte) error {
+	if err := clipboard.WriteAll(ctx, content); err != nil {
+		return fmt.Errorf("failed to write to clipboard: %w", err)
+	}
+
+	return nil
+}
+
+func callCommand(_ context.Context, cmd string, parameter string, stdinValue []byte) error {
 	clipboardProcess := exec.Command(cmd, parameter)
 	stdin, err := clipboardProcess.StdinPipe()
 

pkg/clipboard/clipboard_test.go

@@ -10,7 +10,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/atotto/clipboard"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/config"
 	"github.com/gopasspw/gopass/internal/out"
 	"github.com/mitchellh/go-ps"
@@ -36,7 +36,7 @@ func TestUnsupportedCopyToClipboard(t *testing.T) {
 	ctx, cancel := context.WithCancel(config.NewContextInMemory())
 	defer cancel()
 
-	clipboard.Unsupported = true
+	clipboard.ForceUnsupported = true
 
 	buf := &bytes.Buffer{}
 	out.Stderr = buf
@@ -53,7 +53,7 @@ func TestClearClipboard(t *testing.T) {
 }
 
 func BenchmarkWalkProc(b *testing.B) {
-	for i := 0; i < b.N; i++ { //nolint:intrange // b.N is evaluated at each iteration.
+	for b.Loop() {
 		_ = filepath.Walk("/proc", func(path string, info os.FileInfo, err error) error {
 			if err != nil {
 				return nil
@@ -76,7 +76,7 @@ func BenchmarkWalkProc(b *testing.B) {
 }
 
 func BenchmarkListProc(b *testing.B) {
-	for i := 0; i < b.N; i++ { //nolint:intrange // b.N is evaluated at each iteration.
+	for b.Loop() {
 		procs, err := ps.Processes()
 		if err != nil {
 			b.Fatalf("err: %s", err)

pkg/clipboard/copy_darwin.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/atotto/clipboard"
+	"github.com/gopasspw/clipboard"
 	"github.com/gopasspw/gopass/internal/notify"
 	"github.com/gopasspw/gopass/internal/pwschemes/argon2id"
 	"github.com/gopasspw/gopass/pkg/debug"
@@ -26,11 +26,11 @@ func Clear(ctx context.Context, name string, checksum string, force bool) error
 		return nil
 	}
 
-	if clipboard.Unsupported {
+	if clipboard.IsUnsupported() {
 		return ErrNotSupported
 	}
 
-	cur, err := clipboard.ReadAll()
+	cur, err := clipboard.ReadAllString(ctx)
 	if err != nil {
 		return fmt.Errorf("failed to read clipboard: %w", err)
 	}
@@ -46,7 +46,7 @@ func Clear(ctx context.Context, name string, checksum string, force bool) error
 		return nil
 	}
 
-	if err := clipboard.WriteAll(""); err != nil {
+	if err := clipboard.WriteAllString(ctx, ""); err != nil {
 		_ = notify.Notify(ctx, "gopass - clipboard", "Failed to clear clipboard")
 
 		return fmt.Errorf("failed to write clipboard: %w", err)