Skip to content

Commit 731eeba

Browse files
committed
Use the term "signature base"
1 parent af4d353 commit 731eeba

File tree

4 files changed

+71
-71
lines changed

4 files changed

+71
-71
lines changed

fields.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ func (f field) toItem() httpsfv.Item {
217217
return httpsfv.Item(f)
218218
}
219219

220-
func (f field) asSignatureInput() (string, error) {
220+
func (f field) asSignatureBase() (string, error) {
221221
s, err := httpsfv.Marshal(f.toItem())
222222
return s, err
223223
}

fields_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ func TestFields_asSignatureInput(t *testing.T) {
4444
t.Run(tt.name, func(t *testing.T) {
4545
got, err := tt.fs.asSignatureInput(tt.args.p)
4646
if (err != nil) != tt.wantErr {
47-
t.Errorf("asSignatureInput() error = %v, wantErr %v", err, tt.wantErr)
47+
t.Errorf("asSignatureBase() error = %v, wantErr %v", err, tt.wantErr)
4848
return
4949
}
5050
if got != tt.want {
51-
t.Errorf("asSignatureInput() got = %v, want %v", got, tt.want)
51+
t.Errorf("asSignatureBase() got = %v, want %v", got, tt.want)
5252
}
5353
})
5454
}

signatures.go

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@ import (
1717
)
1818

1919
func signMessage(config SignConfig, signatureName string, signer Signer, parsedMessage parsedMessage,
20-
fields Fields) (signatureInputHeader, signature, signatureInput string, err error) {
20+
fields Fields) (signatureInput, signature, signatureBase string, err error) {
2121
filtered := filterOptionalFields(fields, parsedMessage)
2222
sigParams, err := generateSigParams(&config, signer.keyID, signer.alg, signer.foreignSigner, filtered)
2323
if err != nil {
2424
return "", "", "", err
2525
}
26-
signatureInputHeader = fmt.Sprintf("%s=%s", signatureName, sigParams)
27-
signatureInput, err = generateSignatureInput(parsedMessage, filtered, sigParams)
26+
signatureInput = fmt.Sprintf("%s=%s", signatureName, sigParams)
27+
signatureBase, err = generateSignatureBase(parsedMessage, filtered, sigParams)
2828
if err != nil {
2929
return "", "", "", err
3030
}
31-
signature, err = generateSignature(signatureName, signer, signatureInput)
31+
signature, err = generateSignature(signatureName, signer, signatureBase)
3232
if err != nil {
3333
return "", "", "", err
3434
}
35-
return signatureInputHeader, signature, signatureInput, nil
35+
return signatureInput, signature, signatureBase, nil
3636
}
3737

3838
func filterOptionalFields(fields Fields, message parsedMessage) Fields {
@@ -64,10 +64,10 @@ func encodeBytes(raw []byte) string {
6464
return ":" + base64.StdEncoding.EncodeToString(raw) + ":"
6565
}
6666

67-
func generateSignatureInput(message parsedMessage, fields Fields, params string) (string, error) {
67+
func generateSignatureBase(message parsedMessage, fields Fields, params string) (string, error) {
6868
inp := ""
6969
for _, c := range fields.f {
70-
f, err := c.asSignatureInput()
70+
f, err := c.asSignatureBase()
7171
if err != nil {
7272
return "", fmt.Errorf("could not marshal %v", f)
7373
}
@@ -191,14 +191,14 @@ func generateSigParams(config *SignConfig, keyID, alg string, foreignSigner inte
191191
//
192192
// SignRequest signs an HTTP request. Returns the Signature-Input and the Signature header values.
193193
//
194-
func SignRequest(signatureName string, signer Signer, req *http.Request) (signatureInputHeader, signature string, err error) {
195-
signatureInputHeader, signature, signatureInput, err := signRequestDebug(signatureName, signer, req)
196-
_ = signatureInput
194+
func SignRequest(signatureName string, signer Signer, req *http.Request) (signatureInput, signature string, err error) {
195+
signatureInput, signature, signatureBase, err := signRequestDebug(signatureName, signer, req)
196+
_ = signatureBase
197197
return
198198
}
199199

200200
// Same as SignRequest, but also returns the raw signature input string
201-
func signRequestDebug(signatureName string, signer Signer, req *http.Request) (signatureInputHeader, signature, signatureInput string, err error) {
201+
func signRequestDebug(signatureName string, signer Signer, req *http.Request) (signatureInput, signature, signatureBase string, err error) {
202202
if req == nil {
203203
return "", "", "", fmt.Errorf("nil request")
204204
}
@@ -218,13 +218,13 @@ func signRequestDebug(signatureName string, signer Signer, req *http.Request) (s
218218
//
219219
// SignResponse signs an HTTP response. Returns the Signature-Input and the Signature header values.
220220
//
221-
func SignResponse(signatureName string, signer Signer, res *http.Response) (signatureInputHeader, signature string, err error) {
222-
signatureInputHeader, signature, signatureInput, err := signResponseDebug(signatureName, signer, res)
223-
_ = signatureInput
221+
func SignResponse(signatureName string, signer Signer, res *http.Response) (signatureInput, signature string, err error) {
222+
signatureInput, signature, signatureBase, err := signResponseDebug(signatureName, signer, res)
223+
_ = signatureBase
224224
return
225225
}
226226

227-
func signResponseDebug(signatureName string, signer Signer, res *http.Response) (signatureInputHeader, signatureInput, signature string, err error) {
227+
func signResponseDebug(signatureName string, signer Signer, res *http.Response) (signatureInput, signature, signatureBase string, err error) {
228228
if res == nil {
229229
return "", "", "", fmt.Errorf("nil response")
230230
}
@@ -258,7 +258,7 @@ func VerifyRequest(signatureName string, verifier Verifier, req *http.Request) e
258258
return err
259259
}
260260

261-
func verifyRequestDebug(signatureName string, verifier Verifier, req *http.Request) (signatureInput string, err error) {
261+
func verifyRequestDebug(signatureName string, verifier Verifier, req *http.Request) (signatureBase string, err error) {
262262
if req == nil {
263263
return "", fmt.Errorf("nil request")
264264
}
@@ -416,11 +416,11 @@ func verifyMessage(config VerifyConfig, name string, verifier Verifier, message
416416
if err != nil {
417417
return "", err
418418
}
419-
signatureInput, err := generateSignatureInput(message, psiSig.fields, psiSig.origSigParams)
419+
signatureBase, err := generateSignatureBase(message, psiSig.fields, psiSig.origSigParams)
420420
if err != nil {
421421
return "", err
422422
}
423-
return signatureInput, verifySignature(verifier, signatureInput, wantSigRaw)
423+
return signatureBase, verifySignature(verifier, signatureBase, wantSigRaw)
424424
}
425425

426426
func applyVerificationPolicy(verifier Verifier, message parsedMessage, psi *psiSignature, config VerifyConfig) error {

0 commit comments

Comments
 (0)