All files / src sign.ts

100% Statements 76/76
100% Branches 20/20
100% Functions 13/13
100% Lines 75/75

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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                            2x   2x 2x 2x 2x 2x             14x 2x 2x 2x 2x 2x 2x 2x   2x 2x             2x 19x 19x 19x             19x     2x       2x       2x 2x   2x             2x         4x 4x 4x   4x 1x         3x 1x         2x                     2x         2x 2x 2x       2x 2x         2x                 2x             7x 7x 7x 7x 7x   7x 1x         6x 1x         5x 1x         4x 1x         3x 3x 3x 2x   3x                     2x             4x                                 2x             2x       2x     2x       3x   3x     2x       2x       2x     2x   2x         2x  
/*
 * Copyright © 2019 Lisk Foundation
 *
 * See the LICENSE file at the top-level directory of this distribution
 * for licensing information.
 *
 * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
 * no part of this software, including this file, may be copied, modified,
 * propagated, or distributed except according to the terms contained in the
 * LICENSE file.
 *
 * Removal or modification of this copyright notice is prohibited.
 *
 */
import { encode as encodeVarInt } from 'varuint-bitcoin';
 
import { bufferToHex, hexToBuffer } from './buffer';
import { SIGNED_MESSAGE_PREFIX } from './constants';
import { hash } from './hash';
import { getPrivateAndPublicKeyBytesFromPassphrase } from './keys';
import {
	NACL_SIGN_PUBLICKEY_LENGTH,
	NACL_SIGN_SIGNATURE_LENGTH,
	signDetached,
	verifyDetached,
} from './nacl';
 
const createHeader = (text: string): string => `-----${text}-----`;
const signedMessageHeader = createHeader('BEGIN LISK SIGNED MESSAGE');
const messageHeader = createHeader('MESSAGE');
const publicKeyHeader = createHeader('PUBLIC KEY');
const secondPublicKeyHeader = createHeader('SECOND PUBLIC KEY');
const signatureHeader = createHeader('SIGNATURE');
const secondSignatureHeader = createHeader('SECOND SIGNATURE');
const signatureFooter = createHeader('END LISK SIGNED MESSAGE');
 
const SIGNED_MESSAGE_PREFIX_BYTES = Buffer.from(SIGNED_MESSAGE_PREFIX, 'utf8');
const SIGNED_MESSAGE_PREFIX_LENGTH = encodeVarInt(SIGNED_MESSAGE_PREFIX.length);
 
export interface SignedMessageWithOnePassphrase {
	readonly message: string;
	readonly publicKey: string;
	readonly signature: string;
}
export const digestMessage = (message: string): Buffer => {
	const msgBytes = Buffer.from(message, 'utf8');
	const msgLenBytes = encodeVarInt(message.length);
	const dataBytes = Buffer.concat([
		SIGNED_MESSAGE_PREFIX_LENGTH,
		SIGNED_MESSAGE_PREFIX_BYTES,
		msgLenBytes,
		msgBytes,
	]);
 
	return hash(hash(dataBytes));
};
 
export const signMessageWithPassphrase = (
	message: string,
	passphrase: string,
): SignedMessageWithOnePassphrase => {
	const msgBytes = digestMessage(message);
	const {
		privateKeyBytes,
		publicKeyBytes,
	} = getPrivateAndPublicKeyBytesFromPassphrase(passphrase);
	const signature = signDetached(msgBytes, privateKeyBytes);
 
	return {
		message,
		publicKey: bufferToHex(publicKeyBytes),
		signature: bufferToHex(signature),
	};
};
 
export const verifyMessageWithPublicKey = ({
	message,
	publicKey,
	signature,
}: SignedMessageWithOnePassphrase): boolean => {
	const msgBytes = digestMessage(message);
	const signatureBytes = hexToBuffer(signature);
	const publicKeyBytes = hexToBuffer(publicKey);
 
	if (publicKeyBytes.length !== NACL_SIGN_PUBLICKEY_LENGTH) {
		throw new Error(
			`Invalid publicKey, expected ${NACL_SIGN_PUBLICKEY_LENGTH}-byte publicKey`,
		);
	}
 
	if (signatureBytes.length !== NACL_SIGN_SIGNATURE_LENGTH) {
		throw new Error(
			`Invalid signature length, expected ${NACL_SIGN_SIGNATURE_LENGTH}-byte signature`,
		);
	}
 
	return verifyDetached(msgBytes, signatureBytes, publicKeyBytes);
};
 
export interface SignedMessageWithTwoPassphrases {
	readonly message: string;
	readonly publicKey: string;
	readonly secondPublicKey: string;
	readonly secondSignature: string;
	readonly signature: string;
}
 
export const signMessageWithTwoPassphrases = (
	message: string,
	passphrase: string,
	secondPassphrase: string,
): SignedMessageWithTwoPassphrases => {
	const msgBytes = digestMessage(message);
	const keypairBytes = getPrivateAndPublicKeyBytesFromPassphrase(passphrase);
	const secondKeypairBytes = getPrivateAndPublicKeyBytesFromPassphrase(
		secondPassphrase,
	);
 
	const signature = signDetached(msgBytes, keypairBytes.privateKeyBytes);
	const secondSignature = signDetached(
		msgBytes,
		secondKeypairBytes.privateKeyBytes,
	);
 
	return {
		message,
		publicKey: bufferToHex(keypairBytes.publicKeyBytes),
		secondPublicKey: bufferToHex(secondKeypairBytes.publicKeyBytes),
		signature: bufferToHex(signature),
		secondSignature: bufferToHex(secondSignature),
	};
};
 
export const verifyMessageWithTwoPublicKeys = ({
	message,
	signature,
	secondSignature,
	publicKey,
	secondPublicKey,
}: SignedMessageWithTwoPassphrases) => {
	const messageBytes = digestMessage(message);
	const signatureBytes = hexToBuffer(signature);
	const secondSignatureBytes = hexToBuffer(secondSignature);
	const publicKeyBytes = hexToBuffer(publicKey);
	const secondPublicKeyBytes = hexToBuffer(secondPublicKey);
 
	if (signatureBytes.length !== NACL_SIGN_SIGNATURE_LENGTH) {
		throw new Error(
			`Invalid first signature length, expected ${NACL_SIGN_SIGNATURE_LENGTH}-byte signature`,
		);
	}
 
	if (secondSignatureBytes.length !== NACL_SIGN_SIGNATURE_LENGTH) {
		throw new Error(
			`Invalid second signature length, expected ${NACL_SIGN_SIGNATURE_LENGTH}-byte signature`,
		);
	}
 
	if (publicKeyBytes.length !== NACL_SIGN_PUBLICKEY_LENGTH) {
		throw new Error(
			`Invalid first publicKey, expected ${NACL_SIGN_PUBLICKEY_LENGTH}-byte publicKey`,
		);
	}
 
	if (secondPublicKeyBytes.length !== NACL_SIGN_PUBLICKEY_LENGTH) {
		throw new Error(
			`Invalid second publicKey, expected ${NACL_SIGN_PUBLICKEY_LENGTH}-byte publicKey`,
		);
	}
 
	const verifyFirstSignature = () =>
		verifyDetached(messageBytes, signatureBytes, publicKeyBytes);
	const verifySecondSignature = () =>
		verifyDetached(messageBytes, secondSignatureBytes, secondPublicKeyBytes);
 
	return verifyFirstSignature() && verifySecondSignature();
};
 
export interface SingleOrDoubleSignedMessage {
	readonly message: string;
	readonly publicKey: string;
	readonly secondPublicKey?: string;
	readonly secondSignature?: string;
	readonly signature: string;
}
 
export const printSignedMessage = ({
	message,
	signature,
	publicKey,
	secondSignature,
	secondPublicKey,
}: SingleOrDoubleSignedMessage): string =>
	[
		signedMessageHeader,
		messageHeader,
		message,
		publicKeyHeader,
		publicKey,
		secondPublicKey ? secondPublicKeyHeader : undefined,
		secondPublicKey,
		signatureHeader,
		signature,
		secondSignature ? secondSignatureHeader : undefined,
		secondSignature,
		signatureFooter,
	]
		.filter(Boolean)
		.join('\n');
 
export const signAndPrintMessage = (
	message: string,
	passphrase: string,
	secondPassphrase?: string,
): string => {
	const signedMessage:
		| SignedMessageWithOnePassphrase
		| SignedMessageWithTwoPassphrases = secondPassphrase
		? signMessageWithTwoPassphrases(message, passphrase, secondPassphrase)
		: signMessageWithPassphrase(message, passphrase);
 
	return printSignedMessage(signedMessage);
};
 
export const signDataWithPrivateKey = (
	data: Buffer,
	privateKey: Buffer,
): string => {
	const signature = signDetached(data, privateKey);
 
	return bufferToHex(signature);
};
 
export const signDataWithPassphrase = (
	data: Buffer,
	passphrase: string,
): string => {
	const { privateKeyBytes } = getPrivateAndPublicKeyBytesFromPassphrase(
		passphrase,
	);
 
	return signDataWithPrivateKey(data, privateKeyBytes);
};
 
export const signData = signDataWithPassphrase;
 
export const verifyData = (
	data: Buffer,
	signature: string,
	publicKey: string,
): boolean =>
	verifyDetached(data, hexToBuffer(signature), hexToBuffer(publicKey));