Content-Digest header

Author: yaronf

README.md

@@ -15,8 +15,8 @@ Below is what a basic client-side integration looks like:
 	// Create a signer and a wrapped HTTP client
 	signer, _ := httpsign.NewRSAPSSSigner("key1", *prvKey,
 		httpsign.NewSignConfig(),
-		httpsign.Headers("@request-target"))
-	client := httpsign.NewDefaultClient("sig1", signer, nil, nil) // sign requests, don't verify responses
+		httpsign.Headers("@request-target", "Content-Digest")) // The Content-Digest header will be auto-generated
+	client := httpsign.NewDefaultClient(httpsign.NewClientConfig().SetSignatureName("sig1").SetSigner(signer)) // sign requests, don't verify responses
 
 	// Send an HTTP POST, get response -- signing and verification happen behind the scenes
 	body := `{"hello": "world"}`

client_test.go

@@ -3,10 +3,13 @@ package httpsign
 import (
 	"bytes"
 	"fmt"
+	"github.com/stretchr/testify/assert"
 	"log"
 	"net/http"
 	"net/http/httptest"
+	"net/url"
 	"reflect"
+	"sort"
 	"testing"
 )
 
@@ -239,3 +242,63 @@ func TestClient_Head(t *testing.T) {
 		})
 	}
 }
+
+func TestClient_PostForm(t *testing.T) {
+	type fields struct {
+		config ClientConfig
+		client http.Client
+	}
+	type args struct {
+		url  string
+		data url.Values
+	}
+
+	ts := makeTestServer()
+	defer ts.Close()
+
+	tests := []struct {
+		name            string
+		fields          fields
+		args            args
+		wantRespHeaders []string
+		wantErr         assert.ErrorAssertionFunc
+	}{
+		{
+			name: "happy path",
+			fields: fields{
+				config: *NewClientConfig(),
+				client: *http.DefaultClient,
+			},
+			args: args{
+				url: ts.URL,
+				data: func() url.Values {
+					var v url.Values = url.Values{}
+					v.Add("k1", "v1")
+					v.Set("k2", "v2")
+					return v
+				}(),
+			},
+			wantRespHeaders: []string{"Content-Length", "Content-Type", "Date"},
+			wantErr:         assert.NoError,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := &Client{
+				config: tt.fields.config,
+				client: tt.fields.client,
+			}
+			gotResp, err := c.PostForm(tt.args.url, tt.args.data)
+			if !tt.wantErr(t, err, fmt.Sprintf("PostForm(%v, %v)", tt.args.url, tt.args.data)) {
+				return
+			}
+			headers := []string{}
+			for k, _ := range gotResp.Header {
+				headers = append(headers, k)
+			}
+			sort.Strings(headers)
+			assert.Equalf(t, tt.wantRespHeaders, headers, "PostForm(%v, %v)", tt.args.url, tt.args.data)
+		})
+	}
+}

clientex_test.go

@@ -109,7 +109,7 @@ func TestClientUsage(t *testing.T) {
 	// Create a signer and a wrapped HTTP client
 	signer, _ := httpsign.NewRSAPSSSigner("key1", *prvKey,
 		httpsign.NewSignConfig(),
-		httpsign.Headers("@request-target", "Content-Digest"))
+		httpsign.Headers("@request-target", "Content-Digest")) // The Content-Digest header will be auto-generated
 	client := httpsign.NewDefaultClient(httpsign.NewClientConfig().SetSignatureName("sig1").SetSigner(signer)) // sign requests, don't verify responses
 
 	// Send an HTTP POST, get response -- signing and verification happen behind the scenes

digest_test.go

@@ -20,6 +20,20 @@ Content-Digest: sha-256=:Wqdirjg/u3J688ejbUlApbjECpiUUtIwT8lY/z81Tno=:
 
 "hello"`
 
+var resdigest3 = `HTTP/1.1 206 Partial Content
+Content-Type: application/json
+Content-Range: bytes 1-7/18
+Content-Digest: sha-256=:Wqdirjg/u3J688ejbUlApbjECpiUUtIwT8lY/z81Tno=:
+
+"hello!!"`
+
+var resdigest5 = `HTTP/1.1 206 Partial Content
+Content-Type: application/json
+Content-Range: bytes 1-7/18
+Content-Digest: sha-512=:A8pplr4vsk4xdLkJruCXWp6+i+dy/3pSW5HW5ke1jDWS70Dv6Fstf1jS+XEcLqEVhW3i925IPlf/4tnpnvAQDw==:
+
+"hello"`
+
 func TestMessages(t *testing.T) {
 	res1 := readResponse(resdigest1)
 	d, err := GenerateContentDigest(&res1.Body, DigestSha256)
@@ -33,4 +47,20 @@ func TestMessages(t *testing.T) {
 	assert.NoError(t, err, "should not fail to generate digest")
 	h = res2.Header.Get("Content-Digest")
 	assert.Equal(t, h, d)
+
+	res3 := readResponse(resdigest3)
+	d, err = GenerateContentDigest(&res3.Body, DigestSha256)
+	assert.NoError(t, err, "should not fail to generate digest")
+	h = res3.Header.Get("Content-Digest")
+	assert.NotEqual(t, h, d)
+
+	res4 := readResponse(resdigest3)
+	d, err = GenerateContentDigest(&res4.Body, "sha-999")
+	assert.Error(t, err, "bad digest scheme")
+
+	res5 := readResponse(resdigest5)
+	d, err = GenerateContentDigest(&res5.Body, DigestSha512)
+	assert.NoError(t, err, "should not fail to generate digest")
+	h = res5.Header.Get("Content-Digest")
+	assert.Equal(t, h, d)
 }

handler_test.go

@@ -8,6 +8,7 @@ import (
 	"log"
 	"net/http"
 	"net/http/httptest"
+	"strings"
 	"testing"
 )
 
@@ -38,13 +39,13 @@ func Test_WrapHandler(t *testing.T) {
 	defer ts.Close()
 
 	signer, err := NewHMACSHA256Signer("key", bytes.Repeat([]byte{1}, 64), nil,
-		Headers("@method"))
+		Headers("@method", "content-digest"))
 	assert.NoError(t, err)
 
 	verifier, err := NewHMACSHA256Verifier("key", bytes.Repeat([]byte{0}, 64), NewVerifyConfig(), *NewFields())
 	assert.NoError(t, err)
 	client := NewDefaultClient(NewClientConfig().SetSignatureName("sig1").SetSigner(signer).SetVerifier(verifier).SetDigestScheme(DigestSha256))
-	res, err := client.Get(ts.URL)
+	res, err := client.Post(ts.URL, "text/plain", strings.NewReader("Message body here"))
 	assert.NoError(t, err)
 	if res != nil {
 		_, err = io.ReadAll(res.Body)