Blame view

node_modules/http-signature/README.md 1.56 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  # node-http-signature
  
  node-http-signature is a node.js library that has client and server components
  for Joyent's [HTTP Signature Scheme](http_signing.md).
  
  ## Usage
  
  Note the example below signs a request with the same key/cert used to start an
  HTTP server. This is almost certainly not what you actually want, but is just
  used to illustrate the API calls; you will need to provide your own key
  management in addition to this library.
  
  ### Client
  
  ```js
  var fs = require('fs');
  var https = require('https');
  var httpSignature = require('http-signature');
  
  var key = fs.readFileSync('./key.pem', 'ascii');
  
  var options = {
    host: 'localhost',
    port: 8443,
    path: '/',
    method: 'GET',
    headers: {}
  };
  
  // Adds a 'Date' header in, signs it, and adds the
  // 'Authorization' header in.
  var req = https.request(options, function(res) {
    console.log(res.statusCode);
  });
  
  
  httpSignature.sign(req, {
    key: key,
    keyId: './cert.pem'
  });
  
  req.end();
  ```
  
  ### Server
  
  ```js
  var fs = require('fs');
  var https = require('https');
  var httpSignature = require('http-signature');
  
  var options = {
    key: fs.readFileSync('./key.pem'),
    cert: fs.readFileSync('./cert.pem')
  };
  
  https.createServer(options, function (req, res) {
    var rc = 200;
    var parsed = httpSignature.parseRequest(req);
    var pub = fs.readFileSync(parsed.keyId, 'ascii');
    if (!httpSignature.verifySignature(parsed, pub))
      rc = 401;
  
    res.writeHead(rc);
    res.end();
  }).listen(8443);
  ```
  
  ## Installation
  
      npm install http-signature
  
  ## License
  
  MIT.
  
  ## Bugs
  
  See <https://github.com/joyent/node-http-signature/issues>.