BREAKING CHANGE(encryption): add crypter func to WithCassetteCrypto* …

…CassetteOption

.gitignore

@@ -31,3 +31,4 @@ _testmain.go
 *.test
 *.prof
 /coverage.out
+/bin

README.md

@@ -9,12 +9,12 @@
     <img src="https://github.com/seborama/govcr/actions/workflows/codeql-analysis.yml/badge.svg?branch=master" alt="govcr">
   </a>
 
-  <a href="https://pkg.go.dev/github.com/seborama/govcr/v8">
+  <a href="https://pkg.go.dev/github.com/seborama/govcr/v9">
     <img src="https://img.shields.io/badge/godoc-reference-blue.svg" alt="govcr">
   </a>
 
-  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v8">
-    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v8" alt="govcr">
+  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v9">
+    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v9" alt="govcr">
   </a>
 </p>
 
@@ -50,15 +50,15 @@ We use a "relaxed" request matcher because `example.com` injects an "`Age`" head
 ## Install
 
 ```bash
-go get github.com/seborama/govcr/v8@latest
+go get github.com/seborama/govcr/v9@latest
 ```
 
 For all available releases, please check the [releases](https://github.com/seborama/govcr/releases) tab on github.
 
 And your source code would use this import:
 
 ```go
-import "github.com/seborama/govcr/v8"
+import "github.com/seborama/govcr/v9"
 ```
 
 For versions of **govcr** before v5 (which don't use go.mod), use a dependency manager to lock the version you wish to use (perhaps v4)!
@@ -84,7 +84,7 @@ go get gopkg.in/seborama/govcr.v4
 
 **govcr** is a wrapper around the Go `http.Client`. It can record live HTTP traffic to files (called "**cassettes**") and later replay HTTP requests ("**tracks**") from them instead of live HTTP calls.
 
-The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v8).
+The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v9).
 
 When using **govcr**'s `http.Client`, the request is matched against the **tracks** on the '**cassette**':
 
@@ -185,7 +185,7 @@ As a reminder, you should **never** use a nonce value more than once with the sa
 The command is located in the `cmd/govcr` folder, to install it:
 
 ```bash
-go install github.com/seborama/govcr/v8/cmd/govcr@latest
+go install github.com/seborama/govcr/v9/cmd/govcr@latest
 ```
 
 Example usage:
@@ -344,7 +344,9 @@ At time of creating a new VCR with **govcr**:
 vcr := govcr.NewVCR(
     govcr.WithCassette(
         exampleCassetteName4,
-        govcr.WithCassetteCrypto("test-fixtures/TestExample4.unsafe.key"),
+        govcr.WithCassetteCrypto(
+            encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
+            "test-fixtures/TestExample4.unsafe.key"),
     ),
 )
 ```
@@ -355,7 +357,9 @@ Or, at time of loading a cassette from the `ControlPanel`:
 // See TestExample4 in tests for fully working example.
 err := vcr.LoadCassette(
     exampleCassetteName4,
-    govcr.WithCassetteCrypto("test-fixtures/TestExample4.unsafe.key"),
+    govcr.WithCassetteCrypto(
+        encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
+        "test-fixtures/TestExample4.unsafe.key"),
 )
 ```
 
@@ -380,9 +384,9 @@ vcr := govcr.NewVCR(
     govcr.WithCassette(
         exampleCassetteName4,
         govcr.WithCassetteCryptoCustomNonce(
+            encryption.NewChaCha20Poly1305,
             "test-fixtures/TestExample4.unsafe.key",
-            nonceGenerator,
-        ),
+            nonceGenerator),
     ),
 )
 ```

cassette/cassette.go

@@ -13,11 +13,11 @@ import (
 	"github.com/google/uuid"
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v8/cassette/track"
-	"github.com/seborama/govcr/v8/compression"
-	cryptoerr "github.com/seborama/govcr/v8/encryption/errors"
-	govcrerr "github.com/seborama/govcr/v8/errors"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9/cassette/track"
+	"github.com/seborama/govcr/v9/compression"
+	cryptoerr "github.com/seborama/govcr/v9/encryption/errors"
+	govcrerr "github.com/seborama/govcr/v9/errors"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 // Cassette contains a set of tracks.
@@ -296,6 +296,7 @@ func getEncryptionMarker(data []byte) string {
 	marker := ""
 	for i, b := range data[1:] {
 		if i > 255 {
+			// give up: we should have already met with the closing `$` a long time ago
 			break
 		}
 

cassette/cassette_test.go

@@ -8,9 +8,9 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/cassette"
-	"github.com/seborama/govcr/v8/cassette/track"
-	"github.com/seborama/govcr/v8/encryption"
+	"github.com/seborama/govcr/v9/cassette"
+	"github.com/seborama/govcr/v9/cassette/track"
+	"github.com/seborama/govcr/v9/encryption"
 )
 
 func Test_cassette_GzipFilter(t *testing.T) {

cassette/cassette_wb_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 func Test_cassette_NumberOfTracks_PanicsWhenNoCassette(t *testing.T) {

cassette/track/http_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 func TestRequest_Clone(t *testing.T) {

cassette/track/mutator_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 func Test_Mutator_On(t *testing.T) {

cassette/track/track.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	trkerr "github.com/seborama/govcr/v8/cassette/track/errors"
+	trkerr "github.com/seborama/govcr/v9/cassette/track/errors"
 )
 
 // Track is a recording (HTTP Request + Response) in a cassette.

cmd/govcr/main.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v8/cassette"
-	"github.com/seborama/govcr/v8/encryption"
+	"github.com/seborama/govcr/v9/cassette"
+	"github.com/seborama/govcr/v9/encryption"
 )
 
 func main() {

concurrency_test.go

@@ -15,8 +15,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 func TestConcurrencySafety(t *testing.T) {

controlpanel.go

@@ -3,8 +3,8 @@ package govcr
 import (
 	"net/http"
 
-	"github.com/seborama/govcr/v8/cassette/track"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9/cassette/track"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 // ControlPanel holds the parts of a VCR that can be interacted with.

controlpanel_wb_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 func TestControlPanel_SetRecordingMutators(t *testing.T) {

encryption/.study/rsa.go

@@ -11,7 +11,7 @@ import (
 	"github.com/pkg/errors"
 	"golang.org/x/crypto/ssh"
 
-	cryptoerr "github.com/seborama/govcr/v8/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v9/encryption/errors"
 )
 
 // nolint: deadcode

encryption/aesgcm.go

@@ -4,7 +4,7 @@ import (
 	"crypto/aes"
 	"crypto/cipher"
 
-	cryptoerr "github.com/seborama/govcr/v8/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v9/encryption/errors"
 )
 
 // NewAESGCMWithRandomNonceGenerator creates a new Cryptor initialised with an

encryption/aesgcm_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/encryption"
+	"github.com/seborama/govcr/v9/encryption"
 )
 
 func TestCryptor_AESGCM(t *testing.T) {

encryption/chacha20poly1305_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/encryption"
+	"github.com/seborama/govcr/v9/encryption"
 )
 
 func TestCryptor_ChaCha20Poly1305(t *testing.T) {

examples/Example1_test.go

@@ -4,8 +4,8 @@ import (
 	"os"
 	"testing"
 
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/stats"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )

examples/Example2_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/seborama/govcr/v8"
+	"github.com/seborama/govcr/v9"
 )
 
 const exampleCassetteName2 = "temp-fixtures/TestExample2.cassette.json"

examples/Example3_test.go

@@ -7,8 +7,8 @@ import (
 	"testing"
 
 	"github.com/google/uuid"
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/cassette/track"
 	"github.com/stretchr/testify/require"
 )
 

examples/Example4_test.go

@@ -4,8 +4,9 @@ import (
 	"os"
 	"testing"
 
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/encryption"
+	"github.com/seborama/govcr/v9/stats"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -20,7 +21,9 @@ func TestExample4(t *testing.T) {
 	vcr := govcr.NewVCR(
 		govcr.WithCassette(
 			exampleCassetteName4,
-			govcr.WithCassetteCrypto("test-fixtures/TestExample4.unsafe.key"),
+			govcr.WithCassetteCrypto(
+				encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
+				"test-fixtures/TestExample4.unsafe.key"),
 		),
 		govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
 	)
@@ -43,7 +46,7 @@ func TestExample4(t *testing.T) {
 	vcr.EjectCassette()
 	err := vcr.LoadCassette(
 		exampleCassetteName4,
-		govcr.WithCassetteCrypto("test-fixtures/TestExample4.unsafe.key"),
+		govcr.WithCassetteCrypto(encryption.NewChaCha20Poly1305WithRandomNonceGenerator, "test-fixtures/TestExample4.unsafe.key"),
 	)
 	require.NoError(t, err)
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/seborama/govcr/v8
+module github.com/seborama/govcr/v9
 
 go 1.17
 

govcr_test.go

@@ -14,8 +14,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 func TestNewVCR(t *testing.T) {

govcr_wb_test.go

@@ -12,8 +12,8 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
-	"github.com/seborama/govcr/v8/cassette/track"
-	"github.com/seborama/govcr/v8/stats"
+	"github.com/seborama/govcr/v9/cassette/track"
+	"github.com/seborama/govcr/v9/stats"
 )
 
 type GoVCRWBTestSuite struct {

matchers.go

@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"net/url"
 
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 // RequestMatcherFunc is a function that performs request comparison.

matchers_test.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v8"
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 func Test_DefaultHeaderMatcher(t *testing.T) {

pcb.go

@@ -3,8 +3,8 @@ package govcr
 import (
 	"net/http"
 
-	"github.com/seborama/govcr/v8/cassette"
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 // HTTPMode defines govcr's mode for HTTP requests.

pcb_wb_test.go

@@ -11,8 +11,8 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v8/cassette"
-	"github.com/seborama/govcr/v8/cassette/track"
+	"github.com/seborama/govcr/v9/cassette"
+	"github.com/seborama/govcr/v9/cassette/track"
 )
 
 func TestPrintedCircuitBoard_trackMatches(t *testing.T) {