]>
Commit | Line | Data |
---|---|---|
41fb13c3 | 1 | import { compare, genSalt, hash } from 'bcrypt' |
a3e5f804 | 2 | import { createCipheriv, createDecipheriv, createSign, createVerify } from 'crypto' |
41f2ebae | 3 | import { Request } from 'express' |
41fb13c3 | 4 | import { cloneDeep } from 'lodash' |
f304a158 | 5 | import { sha256 } from '@shared/extra-utils' |
a3e5f804 | 6 | import { BCRYPT_SALT_SIZE, ENCRYPTION, HTTP_SIGNATURE, PRIVATE_RSA_KEY_SIZE } from '../initializers/constants' |
41fb13c3 | 7 | import { MActor } from '../types/models' |
a3e5f804 | 8 | import { generateRSAKeyPairPromise, promisify1, promisify2, randomBytesPromise, scryptPromise } from './core-utils' |
ad513607 | 9 | import { jsonld } from './custom-jsonld-signature' |
8d468a16 | 10 | import { logger } from './logger' |
8d2be0ed | 11 | |
41fb13c3 C |
12 | const bcryptComparePromise = promisify2<any, string, boolean>(compare) |
13 | const bcryptGenSaltPromise = promisify1<number, string>(genSalt) | |
14 | const bcryptHashPromise = promisify2<any, string | number, string>(hash) | |
9f10b292 | 15 | |
5842a854 | 16 | const httpSignature = require('@peertube/http-signature') |
41f2ebae | 17 | |
5d7cb63e | 18 | function createPrivateAndPublicKeys () { |
e4f97bab | 19 | logger.info('Generating a RSA key...') |
bdfbd4f1 | 20 | |
5d7cb63e | 21 | return generateRSAKeyPairPromise(PRIVATE_RSA_KEY_SIZE) |
9f10b292 C |
22 | } |
23 | ||
a3e5f804 | 24 | // --------------------------------------------------------------------------- |
41f2ebae | 25 | // User password checks |
a3e5f804 | 26 | // --------------------------------------------------------------------------- |
41f2ebae C |
27 | |
28 | function comparePassword (plainPassword: string, hashPassword: string) { | |
2166c058 C |
29 | if (!plainPassword) return Promise.resolve(false) |
30 | ||
41f2ebae C |
31 | return bcryptComparePromise(plainPassword, hashPassword) |
32 | } | |
33 | ||
34 | async function cryptPassword (password: string) { | |
35 | const salt = await bcryptGenSaltPromise(BCRYPT_SALT_SIZE) | |
36 | ||
37 | return bcryptHashPromise(password, salt) | |
38 | } | |
39 | ||
a3e5f804 | 40 | // --------------------------------------------------------------------------- |
41f2ebae | 41 | // HTTP Signature |
a3e5f804 | 42 | // --------------------------------------------------------------------------- |
41f2ebae | 43 | |
df66d815 C |
44 | function isHTTPSignatureDigestValid (rawBody: Buffer, req: Request): boolean { |
45 | if (req.headers[HTTP_SIGNATURE.HEADER_NAME] && req.headers['digest']) { | |
46 | return buildDigest(rawBody.toString()) === req.headers['digest'] | |
47 | } | |
48 | ||
49 | return true | |
50 | } | |
51 | ||
453e83ea | 52 | function isHTTPSignatureVerified (httpSignatureParsed: any, actor: MActor): boolean { |
41f2ebae C |
53 | return httpSignature.verifySignature(httpSignatureParsed, actor.publicKey) === true |
54 | } | |
55 | ||
df66d815 | 56 | function parseHTTPSignature (req: Request, clockSkew?: number) { |
e08ec7a7 C |
57 | const requiredHeaders = req.method === 'POST' |
58 | ? [ '(request-target)', 'host', 'digest' ] | |
59 | : [ '(request-target)', 'host' ] | |
797d05bd | 60 | |
e08ec7a7 C |
61 | const parsed = httpSignature.parse(req, { clockSkew, headers: requiredHeaders }) |
62 | ||
63 | const parsedHeaders = parsed.params.headers | |
64 | if (!parsedHeaders.includes('date') && !parsedHeaders.includes('(created)')) { | |
65 | throw new Error(`date or (created) must be included in signature`) | |
66 | } | |
67 | ||
68 | return parsed | |
41f2ebae C |
69 | } |
70 | ||
a3e5f804 | 71 | // --------------------------------------------------------------------------- |
41f2ebae | 72 | // JSONLD |
a3e5f804 | 73 | // --------------------------------------------------------------------------- |
41f2ebae | 74 | |
ad513607 | 75 | function isJsonLDSignatureVerified (fromActor: MActor, signedDocument: any): Promise<boolean> { |
df66d815 | 76 | if (signedDocument.signature.type === 'RsaSignature2017') { |
ad513607 | 77 | return isJsonLDRSA2017Verified(fromActor, signedDocument) |
df66d815 C |
78 | } |
79 | ||
ad513607 | 80 | logger.warn('Unknown JSON LD signature %s.', signedDocument.signature.type, signedDocument) |
bdfbd4f1 | 81 | |
ad513607 | 82 | return Promise.resolve(false) |
26d7d31b C |
83 | } |
84 | ||
df66d815 | 85 | // Backward compatibility with "other" implementations |
453e83ea | 86 | async function isJsonLDRSA2017Verified (fromActor: MActor, signedDocument: any) { |
df66d815 | 87 | const [ documentHash, optionsHash ] = await Promise.all([ |
ad513607 C |
88 | createDocWithoutSignatureHash(signedDocument), |
89 | createSignatureHash(signedDocument.signature) | |
df66d815 C |
90 | ]) |
91 | ||
92 | const toVerify = optionsHash + documentHash | |
93 | ||
94 | const verify = createVerify('RSA-SHA256') | |
95 | verify.update(toVerify, 'utf8') | |
96 | ||
97 | return verify.verify(fromActor.publicKey, signedDocument.signature.signatureValue, 'base64') | |
98 | } | |
99 | ||
db4b15f2 | 100 | async function signJsonLDObject <T> (byActor: MActor, data: T) { |
ad513607 C |
101 | const signature = { |
102 | type: 'RsaSignature2017', | |
ce33ee01 | 103 | creator: byActor.url, |
ad513607 | 104 | created: new Date().toISOString() |
f5028693 | 105 | } |
9f10b292 | 106 | |
ad513607 C |
107 | const [ documentHash, optionsHash ] = await Promise.all([ |
108 | createDocWithoutSignatureHash(data), | |
109 | createSignatureHash(signature) | |
110 | ]) | |
111 | ||
112 | const toSign = optionsHash + documentHash | |
113 | ||
114 | const sign = createSign('RSA-SHA256') | |
115 | sign.update(toSign, 'utf8') | |
116 | ||
117 | const signatureValue = sign.sign(byActor.privateKey, 'base64') | |
118 | Object.assign(signature, { signatureValue }) | |
119 | ||
120 | return Object.assign(data, { signature }) | |
e4f97bab C |
121 | } |
122 | ||
a3e5f804 C |
123 | // --------------------------------------------------------------------------- |
124 | ||
8dc8a34e C |
125 | function buildDigest (body: any) { |
126 | const rawBody = typeof body === 'string' ? body : JSON.stringify(body) | |
127 | ||
128 | return 'SHA-256=' + sha256(rawBody, 'base64') | |
129 | } | |
130 | ||
a3e5f804 C |
131 | // --------------------------------------------------------------------------- |
132 | // Encryption | |
133 | // --------------------------------------------------------------------------- | |
134 | ||
135 | async function encrypt (str: string, secret: string) { | |
136 | const iv = await randomBytesPromise(ENCRYPTION.IV) | |
137 | ||
138 | const key = await scryptPromise(secret, ENCRYPTION.SALT, 32) | |
139 | const cipher = createCipheriv(ENCRYPTION.ALGORITHM, key, iv) | |
140 | ||
141 | let encrypted = iv.toString(ENCRYPTION.ENCODING) + ':' | |
142 | encrypted += cipher.update(str, 'utf8', ENCRYPTION.ENCODING) | |
143 | encrypted += cipher.final(ENCRYPTION.ENCODING) | |
144 | ||
145 | return encrypted | |
146 | } | |
147 | ||
148 | async function decrypt (encryptedArg: string, secret: string) { | |
149 | const [ ivStr, encryptedStr ] = encryptedArg.split(':') | |
150 | ||
151 | const iv = Buffer.from(ivStr, 'hex') | |
152 | const key = await scryptPromise(secret, ENCRYPTION.SALT, 32) | |
153 | ||
154 | const decipher = createDecipheriv(ENCRYPTION.ALGORITHM, key, iv) | |
155 | ||
156 | return decipher.update(encryptedStr, ENCRYPTION.ENCODING, 'utf8') + decipher.final('utf8') | |
157 | } | |
158 | ||
9f10b292 | 159 | // --------------------------------------------------------------------------- |
dac0a531 | 160 | |
65fcc311 | 161 | export { |
df66d815 | 162 | isHTTPSignatureDigestValid, |
41f2ebae C |
163 | parseHTTPSignature, |
164 | isHTTPSignatureVerified, | |
8dc8a34e | 165 | buildDigest, |
41f2ebae | 166 | isJsonLDSignatureVerified, |
65fcc311 | 167 | comparePassword, |
e4f97bab | 168 | createPrivateAndPublicKeys, |
65fcc311 | 169 | cryptPassword, |
a3e5f804 C |
170 | signJsonLDObject, |
171 | ||
172 | encrypt, | |
173 | decrypt | |
9f10b292 | 174 | } |
8d2be0ed C |
175 | |
176 | // --------------------------------------------------------------------------- | |
ad513607 | 177 | |
41fb13c3 | 178 | function hashObject (obj: any): Promise<any> { |
edacb640 C |
179 | return jsonld.promises.normalize(obj, { |
180 | safe: false, | |
181 | algorithm: 'URDNA2015', | |
182 | format: 'application/n-quads' | |
183 | }).then(res => sha256(res)) | |
ad513607 C |
184 | } |
185 | ||
186 | function createSignatureHash (signature: any) { | |
187 | const signatureCopy = cloneDeep(signature) | |
188 | Object.assign(signatureCopy, { | |
189 | '@context': [ | |
190 | 'https://w3id.org/security/v1', | |
191 | { RsaSignature2017: 'https://w3id.org/security#RsaSignature2017' } | |
192 | ] | |
193 | }) | |
194 | ||
195 | delete signatureCopy.type | |
196 | delete signatureCopy.id | |
197 | delete signatureCopy.signatureValue | |
198 | ||
41fb13c3 | 199 | return hashObject(signatureCopy) |
ad513607 C |
200 | } |
201 | ||
202 | function createDocWithoutSignatureHash (doc: any) { | |
203 | const docWithoutSignature = cloneDeep(doc) | |
204 | delete docWithoutSignature.signature | |
205 | ||
41fb13c3 | 206 | return hashObject(docWithoutSignature) |
ad513607 | 207 | } |