]>
Commit | Line | Data |
---|---|---|
1 | import { compare, genSalt, hash } from 'bcrypt' | |
2 | import { createSign, createVerify } from 'crypto' | |
3 | import { Request } from 'express' | |
4 | import { cloneDeep } from 'lodash' | |
5 | import { sha256 } from '@shared/extra-utils' | |
6 | import { BCRYPT_SALT_SIZE, HTTP_SIGNATURE, PRIVATE_RSA_KEY_SIZE } from '../initializers/constants' | |
7 | import { MActor } from '../types/models' | |
8 | import { createPrivateKey, getPublicKey, promisify1, promisify2 } from './core-utils' | |
9 | import { jsonld } from './custom-jsonld-signature' | |
10 | import { logger } from './logger' | |
11 | ||
12 | const bcryptComparePromise = promisify2<any, string, boolean>(compare) | |
13 | const bcryptGenSaltPromise = promisify1<number, string>(genSalt) | |
14 | const bcryptHashPromise = promisify2<any, string | number, string>(hash) | |
15 | ||
16 | const httpSignature = require('@peertube/http-signature') | |
17 | ||
18 | async function createPrivateAndPublicKeys () { | |
19 | logger.info('Generating a RSA key...') | |
20 | ||
21 | const { key } = await createPrivateKey(PRIVATE_RSA_KEY_SIZE) | |
22 | const { publicKey } = await getPublicKey(key) | |
23 | ||
24 | return { privateKey: key, publicKey } | |
25 | } | |
26 | ||
27 | // User password checks | |
28 | ||
29 | function comparePassword (plainPassword: string, hashPassword: string) { | |
30 | return bcryptComparePromise(plainPassword, hashPassword) | |
31 | } | |
32 | ||
33 | async function cryptPassword (password: string) { | |
34 | const salt = await bcryptGenSaltPromise(BCRYPT_SALT_SIZE) | |
35 | ||
36 | return bcryptHashPromise(password, salt) | |
37 | } | |
38 | ||
39 | // HTTP Signature | |
40 | ||
41 | function isHTTPSignatureDigestValid (rawBody: Buffer, req: Request): boolean { | |
42 | if (req.headers[HTTP_SIGNATURE.HEADER_NAME] && req.headers['digest']) { | |
43 | return buildDigest(rawBody.toString()) === req.headers['digest'] | |
44 | } | |
45 | ||
46 | return true | |
47 | } | |
48 | ||
49 | function isHTTPSignatureVerified (httpSignatureParsed: any, actor: MActor): boolean { | |
50 | return httpSignature.verifySignature(httpSignatureParsed, actor.publicKey) === true | |
51 | } | |
52 | ||
53 | function parseHTTPSignature (req: Request, clockSkew?: number) { | |
54 | const requiredHeaders = req.method === 'POST' | |
55 | ? [ '(request-target)', 'host', 'digest' ] | |
56 | : [ '(request-target)', 'host' ] | |
57 | ||
58 | const parsed = httpSignature.parse(req, { clockSkew, headers: requiredHeaders }) | |
59 | ||
60 | const parsedHeaders = parsed.params.headers | |
61 | if (!parsedHeaders.includes('date') && !parsedHeaders.includes('(created)')) { | |
62 | throw new Error(`date or (created) must be included in signature`) | |
63 | } | |
64 | ||
65 | return parsed | |
66 | } | |
67 | ||
68 | // JSONLD | |
69 | ||
70 | function isJsonLDSignatureVerified (fromActor: MActor, signedDocument: any): Promise<boolean> { | |
71 | if (signedDocument.signature.type === 'RsaSignature2017') { | |
72 | return isJsonLDRSA2017Verified(fromActor, signedDocument) | |
73 | } | |
74 | ||
75 | logger.warn('Unknown JSON LD signature %s.', signedDocument.signature.type, signedDocument) | |
76 | ||
77 | return Promise.resolve(false) | |
78 | } | |
79 | ||
80 | // Backward compatibility with "other" implementations | |
81 | async function isJsonLDRSA2017Verified (fromActor: MActor, signedDocument: any) { | |
82 | const [ documentHash, optionsHash ] = await Promise.all([ | |
83 | createDocWithoutSignatureHash(signedDocument), | |
84 | createSignatureHash(signedDocument.signature) | |
85 | ]) | |
86 | ||
87 | const toVerify = optionsHash + documentHash | |
88 | ||
89 | const verify = createVerify('RSA-SHA256') | |
90 | verify.update(toVerify, 'utf8') | |
91 | ||
92 | return verify.verify(fromActor.publicKey, signedDocument.signature.signatureValue, 'base64') | |
93 | } | |
94 | ||
95 | async function signJsonLDObject <T> (byActor: MActor, data: T) { | |
96 | const signature = { | |
97 | type: 'RsaSignature2017', | |
98 | creator: byActor.url, | |
99 | created: new Date().toISOString() | |
100 | } | |
101 | ||
102 | const [ documentHash, optionsHash ] = await Promise.all([ | |
103 | createDocWithoutSignatureHash(data), | |
104 | createSignatureHash(signature) | |
105 | ]) | |
106 | ||
107 | const toSign = optionsHash + documentHash | |
108 | ||
109 | const sign = createSign('RSA-SHA256') | |
110 | sign.update(toSign, 'utf8') | |
111 | ||
112 | const signatureValue = sign.sign(byActor.privateKey, 'base64') | |
113 | Object.assign(signature, { signatureValue }) | |
114 | ||
115 | return Object.assign(data, { signature }) | |
116 | } | |
117 | ||
118 | function buildDigest (body: any) { | |
119 | const rawBody = typeof body === 'string' ? body : JSON.stringify(body) | |
120 | ||
121 | return 'SHA-256=' + sha256(rawBody, 'base64') | |
122 | } | |
123 | ||
124 | // --------------------------------------------------------------------------- | |
125 | ||
126 | export { | |
127 | isHTTPSignatureDigestValid, | |
128 | parseHTTPSignature, | |
129 | isHTTPSignatureVerified, | |
130 | buildDigest, | |
131 | isJsonLDSignatureVerified, | |
132 | comparePassword, | |
133 | createPrivateAndPublicKeys, | |
134 | cryptPassword, | |
135 | signJsonLDObject | |
136 | } | |
137 | ||
138 | // --------------------------------------------------------------------------- | |
139 | ||
140 | function hashObject (obj: any): Promise<any> { | |
141 | return jsonld.promises | |
142 | .normalize(obj, { | |
143 | algorithm: 'URDNA2015', | |
144 | format: 'application/n-quads' | |
145 | }) | |
146 | .then(res => sha256(res)) | |
147 | } | |
148 | ||
149 | function createSignatureHash (signature: any) { | |
150 | const signatureCopy = cloneDeep(signature) | |
151 | Object.assign(signatureCopy, { | |
152 | '@context': [ | |
153 | 'https://w3id.org/security/v1', | |
154 | { RsaSignature2017: 'https://w3id.org/security#RsaSignature2017' } | |
155 | ] | |
156 | }) | |
157 | ||
158 | delete signatureCopy.type | |
159 | delete signatureCopy.id | |
160 | delete signatureCopy.signatureValue | |
161 | ||
162 | return hashObject(signatureCopy) | |
163 | } | |
164 | ||
165 | function createDocWithoutSignatureHash (doc: any) { | |
166 | const docWithoutSignature = cloneDeep(doc) | |
167 | delete docWithoutSignature.signature | |
168 | ||
169 | return hashObject(docWithoutSignature) | |
170 | } |