httpsig/httpsig_test.go at master · Milkhaa/httpsig · GitHub

History

551 lines (517 loc) · 17.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

package httpsig

import (

"bytes"

"crypto"

"crypto/rand"

"crypto/rsa"

"crypto/sha256"

"crypto/x509"

"encoding/base64"

"encoding/pem"

"fmt"

"io/ioutil"

"net/http"

"net/http/httptest"

"strconv"

"strings"

"testing"

)

const (

testUrl = "foo.net/bar/baz?q=test&r=ok"

testUrlPath = "bar/baz"

testDate = "Tue, 07 Jun 2014 20:51:35 GMT"

testDigest = "SHA-256=X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE="

testMethod = "GET"

)

type httpsigTest struct {

name string

prefs []Algorithm

headers []string

scheme SignatureScheme

privKey crypto.PrivateKey

pubKey crypto.PublicKey

pubKeyId string

expectedAlgorithm Algorithm

expectErrorSigningResponse bool

expectRequestPath bool

}

var (

privKey *rsa.PrivateKey

macKey []byte

tests []httpsigTest

testSpecRSAPrivateKey *rsa.PrivateKey

testSpecRSAPublicKey *rsa.PublicKey

)

func init() {

var err error

privKey, err = rsa.GenerateKey(rand.Reader, 2048)

if err != nil {

panic(err)

}

macKey = make([]byte, 128)

err = readFullFromCrypto(macKey)

if err != nil {

panic(err)

}

tests = []httpsigTest{

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

{

prefs: []Algorithm{HMAC_SHA256},

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: macKey,

pubKey: macKey,

pubKeyId: "pubKeyId",

expectedAlgorithm: HMAC_SHA256,

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest"},

scheme: Authorization,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

{

prefs: []Algorithm{HMAC_SHA256},

headers: []string{"Date", "Digest"},

scheme: Authorization,

privKey: macKey,

pubKey: macKey,

pubKeyId: "pubKeyId",

expectedAlgorithm: HMAC_SHA256,

{

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA256,

{

prefs: []Algorithm{RSA_SHA512},

scheme: Signature,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "i write code that sucks",

expectedAlgorithm: RSA_SHA512,

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest", RequestTarget},

scheme: Signature,

privKey: privKey,

pubKey: privKey.Public(),

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

expectErrorSigningResponse: true,

expectRequestPath: true,

}

testSpecRSAPrivateKey, err = loadPrivateKey([]byte(testSpecPrivateKeyPEM))

if err != nil {

panic(err)

}

testSpecRSAPublicKey, err = loadPublicKey([]byte(testSpecPublicKeyPEM))

if err != nil {

panic(err)

}

func toSignatureParameter(k, v string) string {

return fmt.Sprintf("%s%s%s%s%s", k, parameterKVSeparater, parameterValueDelimiter, v, parameterValueDelimiter)

}

func toHeaderSignatureParameters(k string, vals []string) string {

if len(vals) == 0 {

vals = defaultHeaders

}

v := strings.Join(vals, headerParameterValueDelim)

k = strings.ToLower(k)

v = strings.ToLower(v)

return fmt.Sprintf("%s%s%s%s%s", k, parameterKVSeparater, parameterValueDelimiter, v, parameterValueDelimiter)

}

func TestSignerRequest(t *testing.T) {

testFn := func(t *testing.T, test httpsigTest) {

s, a, err := NewSigner(test.prefs, test.headers, test.scheme)

if err != nil {

t.Fatalf("%s", err)

}

if a != test.expectedAlgorithm {

t.Fatalf("got %s, want %s", a, test.expectedAlgorithm)

}

// Test request signing

req, err := http.NewRequest(testMethod, testUrl, nil)

if err != nil {

t.Fatalf("%s", err)

}

req.Header.Set("Date", testDate)

req.Header.Set("Digest", testDigest)

err = s.SignRequest(test.privKey, test.pubKeyId, req)

if err != nil {

t.Fatalf("%s", err)

}

vals, ok := req.Header[string(test.scheme)]

if !ok {

t.Fatalf("not in header %s", test.scheme)

}

if len(vals) != 1 {

t.Fatalf("too many in header %s: %d", test.scheme, len(vals))

}

if p := toSignatureParameter(keyIdParameter, test.pubKeyId); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if p := toSignatureParameter(algorithmParameter, string(test.expectedAlgorithm)); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if p := toHeaderSignatureParameters(headersParameter, test.headers); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if !strings.Contains(vals[0], signatureParameter) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], signatureParameter)

}

// For schemes with an authScheme, enforce its is present and at the beginning

if len(test.scheme.authScheme()) > 0 {

if !strings.HasPrefix(vals[0], test.scheme.authScheme()) {

t.Fatalf("%s\ndoes not start with\n%s", vals[0], test.scheme.authScheme())

}

for _, test := range tests {

t.Run(test.name, func(t *testing.T) {

testFn(t, test)

})

}

func TestSignerResponse(t *testing.T) {

testFn := func(t *testing.T, test httpsigTest) {

s, _, err := NewSigner(test.prefs, test.headers, test.scheme)

// Test response signing

resp := httptest.NewRecorder()

resp.HeaderMap.Set("Date", testDate)

resp.HeaderMap.Set("Digest", testDigest)

err = s.SignResponse(test.privKey, test.pubKeyId, resp)

if test.expectErrorSigningResponse {

if err != nil {

// Skip rest of testing

return

} else {

t.Fatalf("expected error, got nil")

}

vals, ok := resp.HeaderMap[string(test.scheme)]

if !ok {

t.Fatalf("not in header %s", test.scheme)

}

if len(vals) != 1 {

t.Fatalf("too many in header %s: %d", test.scheme, len(vals))

}

if p := toSignatureParameter(keyIdParameter, test.pubKeyId); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if p := toSignatureParameter(algorithmParameter, string(test.expectedAlgorithm)); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if p := toHeaderSignatureParameters(headersParameter, test.headers); !strings.Contains(vals[0], p) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], p)

} else if !strings.Contains(vals[0], signatureParameter) {

t.Fatalf("%s\ndoes not contain\n%s", vals[0], signatureParameter)

}

// For schemes with an authScheme, enforce its is present and at the beginning

if len(test.scheme.authScheme()) > 0 {

if !strings.HasPrefix(vals[0], test.scheme.authScheme()) {

t.Fatalf("%s\ndoes not start with\n%s", vals[0], test.scheme.authScheme())

}

for _, test := range tests {

t.Run(test.name, func(t *testing.T) {

testFn(t, test)

})

}

func TestNewSignerRequestMissingHeaders(t *testing.T) {

failingTests := []struct {

name string

prefs []Algorithm

headers []string

scheme SignatureScheme

privKey crypto.PrivateKey

pubKeyId string

expectedAlgorithm Algorithm

}{

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: privKey,

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

}

for _, test := range failingTests {

t.Run(test.name, func(t *testing.T) {

test := test

s, a, err := NewSigner(test.prefs, test.headers, test.scheme)

if err != nil {

t.Fatalf("%s", err)

}

if a != test.expectedAlgorithm {

t.Fatalf("got %s, want %s", a, test.expectedAlgorithm)

}

req, err := http.NewRequest(testMethod, testUrl, nil)

if err != nil {

t.Fatalf("%s", err)

}

req.Header.Set("Date", testDate)

err = s.SignRequest(test.privKey, test.pubKeyId, req)

if err == nil {

t.Fatalf("expect error but got nil")

}

})

}

func TestNewSignerResponseMissingHeaders(t *testing.T) {

failingTests := []struct {

name string

prefs []Algorithm

headers []string

scheme SignatureScheme

privKey crypto.PrivateKey

pubKeyId string

expectedAlgorithm Algorithm

expectErrorSigningResponse bool

}{

{

prefs: []Algorithm{RSA_SHA512},

headers: []string{"Date", "Digest"},

scheme: Signature,

privKey: privKey,

pubKeyId: "pubKeyId",

expectedAlgorithm: RSA_SHA512,

}

for _, test := range failingTests {

t.Run(test.name, func(t *testing.T) {

test := test

s, a, err := NewSigner(test.prefs, test.headers, test.scheme)

if err != nil {

t.Fatalf("%s", err)

}

if a != test.expectedAlgorithm {

t.Fatalf("got %s, want %s", a, test.expectedAlgorithm)

}

resp := httptest.NewRecorder()

resp.HeaderMap.Set("Date", testDate)

resp.HeaderMap.Set("Digest", testDigest)

err = s.SignResponse(test.privKey, test.pubKeyId, resp)

if err != nil {

t.Fatalf("expected error, got nil")

}

})

}

func TestNewVerifier(t *testing.T) {

for _, test := range tests {

t.Run(test.name, func(t *testing.T) {

test := test

// Prepare

req, err := http.NewRequest(testMethod, testUrl, nil)

if err != nil {

t.Fatalf("%s", err)

}

req.Header.Set("Date", testDate)

req.Header.Set("Digest", testDigest)

s, _, err := NewSigner(test.prefs, test.headers, test.scheme)

if err != nil {

t.Fatalf("%s", err)

}

err = s.SignRequest(test.privKey, test.pubKeyId, req)

if err != nil {

t.Fatalf("%s", err)

}

// Test verification

v, err := NewVerifier(req)

if err != nil {

t.Fatalf("%s", err)

}

if v.KeyId() != test.pubKeyId {

t.Fatalf("got %s, want %s", v.KeyId(), test.pubKeyId)

}

err = v.Verify(test.pubKey, test.expectedAlgorithm)

if err != nil {

t.Fatalf("%s", err)

}

})

}

func TestNewResponseVerifier(t *testing.T) {

for _, test := range tests {

t.Run(test.name, func(t *testing.T) {

test := test

if test.expectErrorSigningResponse {

return

}

// Prepare

resp := httptest.NewRecorder()

resp.HeaderMap.Set("Date", testDate)

resp.HeaderMap.Set("Digest", testDigest)

s, _, err := NewSigner(test.prefs, test.headers, test.scheme)

if err != nil {

t.Fatalf("%s", err)

}

err = s.SignResponse(test.privKey, test.pubKeyId, resp)

if err != nil {

t.Fatalf("%s", err)

}

// Test verification

v, err := NewResponseVerifier(resp.Result())

if err != nil {

t.Fatalf("%s", err)

}

if v.KeyId() != test.pubKeyId {

t.Fatalf("got %s, want %s", v.KeyId(), test.pubKeyId)

}

err = v.Verify(test.pubKey, test.expectedAlgorithm)

if err != nil {

t.Fatalf("%s", err)

}

})

}

// Test_Signing_HTTP_Messages_AppendixC these tests implement Appendix C from the http signatures specification https://tools.ietf.org/html/draft-cavage-http-signatures-10#appendix-C

func Test_Signing_HTTP_Messages_AppendixC(t *testing.T) {

specTests := []struct {

name string

headers []string

expectedSignature string

setHeaders func(r *http.Request)

}{

{

headers: []string{},

expectedSignature: `Authorization: Signature keyId="Test",algorithm="rsa-sha256",signature="SjWJWbWN7i0wzBvtPl8rbASWz5xQW6mcJmn+ibttBqtifLN7Sazz6m79cNfwwb8DMJ5cou1s7uEGKKCs+FLEEaDV5lp7q25WqS+lavg7T8hc0GppauB6hbgEKTwblDHYGEtbGmtdHgVCk9SuS13F0hZ8FD0k/5OxEPXe5WozsbM="`,

setHeaders: func(r *http.Request) {},

{

headers: []string{"(request-target)", "host", "date"},

expectedSignature: `Authorization: Signature keyId="Test",algorithm="rsa-sha256",headers="(request-target) host date",signature="qdx+H7PHHDZgy4y/Ahn9Tny9V3GP6YgBPyUXMmoxWtLbHpUnXS2mg2+SbrQDMCJypxBLSPQR2aAjn7ndmw2iicw3HMbe8VfEdKFYRqzic+efkb3nndiv/x1xSHDJWeSWkx3ButlYSuBskLu6kd9Fswtemr3lgdDEmn04swr2Os0="`,

setHeaders: func(r *http.Request) {},

{

headers: []string{"(request-target)", "host", "date", "content-type", "digest", "content-length"},

expectedSignature: `Authorization: Signature keyId="Test",algorithm="rsa-sha256",headers="(request-target) host date content-type digest content-length",signature="vSdrb+dS3EceC9bcwHSo4MlyKS59iFIrhgYkz8+oVLEEzmYZZvRs8rgOp+63LEM3v+MFHB32NfpB2bEKBIvB1q52LaEUHFv120V01IL+TAD48XaERZFukWgHoBTLMhYS2Gb51gWxpeIq8knRmPnYePbF5MOkR0Zkly4zKH7s1dE="`,

setHeaders: func(r *http.Request) {},

}

for _, test := range specTests {

t.Run(test.name, func(t *testing.T) {

test := test

r, err := http.NewRequest("POST", "http://example.com/foo?param=value&pet=dog", bytes.NewBuffer([]byte(testSpecBody)))

if err != nil {

t.Fatalf("error creating request: %s", err)

}

r.Header["Date"] = []string{testSpecDate}

r.Header["Host"] = []string{r.URL.Host}

r.Header["Content-Length"] = []string{strconv.Itoa(len(testSpecBody))}

r.Header["Content-Type"] = []string{"application/json"}

setDigest(r)

s, _, err := NewSigner([]Algorithm{RSA_SHA256}, test.headers, Authorization)

if err != nil {

t.Fatalf("error creating signer: %s", err)

}

if err := s.SignRequest(testSpecRSAPrivateKey, "Test", r); err != nil {

t.Fatalf("error signing request: %s", err)

}

expectedAuth := test.expectedSignature

gotAuth := fmt.Sprintf("Authorization: %s", r.Header["Authorization"][0])

if gotAuth != expectedAuth {

t.Errorf("%s\nGot: %s\nWant:%s", test.name, gotAuth, expectedAuth)

}

})

}

func loadPrivateKey(keyData []byte) (*rsa.PrivateKey, error) {

pem, _ := pem.Decode(keyData)

if pem.Type != "RSA PRIVATE KEY" {

return nil, fmt.Errorf("RSA private key is of the wrong type: %s", pem.Type)

}

return x509.ParsePKCS1PrivateKey(pem.Bytes)

}

func loadPublicKey(keyData []byte) (*rsa.PublicKey, error) {

pem, _ := pem.Decode(keyData)

if pem.Type != "PUBLIC KEY" {

return nil, fmt.Errorf("public key is of the wrong type: %s", pem.Type)

}

key, err := x509.ParsePKIXPublicKey(pem.Bytes)

if err != nil {

return nil, err

}

return key.(*rsa.PublicKey), nil

}

func setDigest(r *http.Request) ([]byte, error) {

var bodyBytes []byte

if _, ok := r.Header["Digest"]; !ok {

body := ""

if r.Body != nil {

var err error

bodyBytes, err = ioutil.ReadAll(r.Body)

if err != nil {

return nil, fmt.Errorf("error reading body. %v", err)

}

// And now set a new body, which will simulate the same data we read:

r.Body = ioutil.NopCloser(bytes.NewBuffer(bodyBytes))

body = string(bodyBytes)

}

d := sha256.Sum256([]byte(body))

r.Header["Digest"] = []string{fmt.Sprintf("SHA-256=%s", base64.StdEncoding.EncodeToString(d[:]))}

}

return bodyBytes, nil

}

const testSpecBody = `{"hello": "world"}`

const testSpecDate = `Sun, 05 Jan 2014 21:31:40 GMT`

const testSpecPrivateKeyPEM = `-----BEGIN RSA PRIVATE KEY-----

MIICXgIBAAKBgQDCFENGw33yGihy92pDjZQhl0C36rPJj+CvfSC8+q28hxA161QF

NUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6Z4UMR7EOcpfdUE9Hf3m/hs+F

UR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJwoYi+1hqp1fIekaxsyQIDAQAB

AoGBAJR8ZkCUvx5kzv+utdl7T5MnordT1TvoXXJGXK7ZZ+UuvMNUCdN2QPc4sBiA

QWvLw1cSKt5DsKZ8UETpYPy8pPYnnDEz2dDYiaew9+xEpubyeW2oH4Zx71wqBtOK

kqwrXa/pzdpiucRRjk6vE6YY7EBBs/g7uanVpGibOVAEsqH1AkEA7DkjVH28WDUg

f1nqvfn2Kj6CT7nIcE3jGJsZZ7zlZmBmHFDONMLUrXR/Zm3pR5m0tCmBqa5RK95u

412jt1dPIwJBANJT3v8pnkth48bQo/fKel6uEYyboRtA5/uHuHkZ6FQF7OUkGogc

mSJluOdc5t6hI1VsLn0QZEjQZMEOWr+wKSMCQQCC4kXJEsHAve77oP6HtG/IiEn7

kpyUXRNvFsDE0czpJJBvL/aRFUJxuRK91jhjC68sA7NsKMGg5OXb5I5Jj36xAkEA

gIT7aFOYBFwGgQAQkWNKLvySgKbAZRTeLBacpHMuQdl1DfdntvAyqpAZ0lY0RKmW

G6aFKaqQfOXKCyWoUiVknQJAXrlgySFci/2ueKlIE1QqIiLSZ8V8OlpFLRnb1pzI

7U1yQXnTAEFYM560yJlzUpOb1V4cScGd365tiSMvxLOvTA==

-----END RSA PRIVATE KEY-----`

const testSpecPublicKeyPEM = `-----BEGIN PUBLIC KEY-----

MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDCFENGw33yGihy92pDjZQhl0C3

6rPJj+CvfSC8+q28hxA161QFNUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6

Z4UMR7EOcpfdUE9Hf3m/hs+FUR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJw

oYi+1hqp1fIekaxsyQIDAQAB

-----END PUBLIC KEY-----`

httpsig/httpsig_test.go at master · Milkhaa/httpsig · GitHub

Expand file tree

Breadcrumbs

httpsig_test.go

Latest commit

History

Breadcrumbs

httpsig_test.go

File metadata and controls