src/crypto/crypto.ts
Methods |
| decodeBase64StringUtf8 | ||||||
decodeBase64StringUtf8(base64: string)
|
||||||
|
Defined in src/crypto/crypto.ts:52
|
||||||
|
Parameters :
Returns :
string
|
| encodeBase64StringUtf8 | ||||||
encodeBase64StringUtf8(text: string)
|
||||||
|
Defined in src/crypto/crypto.ts:53
|
||||||
|
Parameters :
Returns :
string
|
| randomBytesBase64 | ||||||
randomBytesBase64(n: number)
|
||||||
|
Defined in src/crypto/crypto.ts:42
|
||||||
|
Parameters :
Returns :
string
|
| sha256DigestBase64 | ||||||
sha256DigestBase64(str: string)
|
||||||
|
Defined in src/crypto/crypto.ts:41
|
||||||
|
Parameters :
Returns :
Promise<string>
|
| sha256DigestHex | ||||||||
sha256DigestHex(str: string)
|
||||||||
|
Defined in src/crypto/crypto.ts:60
|
||||||||
|
Computes the SHA-256 hash of the provided string. string in hexadecimal encoding.
Parameters :
Returns :
Promise<string>
A promise that resolves with the SHA-256 hash of the provided string in hexadecimal encoding. |
| sign | |||||||||
sign(privateKey: string | JwkCertificate, data: string | Buffer)
|
|||||||||
|
Defined in src/crypto/crypto.ts:48
|
|||||||||
|
Parameters :
Returns :
Promise<string>
|
| signWithHmacSha256 | ||||||||||||
signWithHmacSha256(key: string | ArrayBuffer, msg: string)
|
||||||||||||
|
Defined in src/crypto/crypto.ts:70
|
||||||||||||
|
Computes the HMAC hash of a message using the provided crypto key and the SHA-256 algorithm. format.
Parameters :
Returns :
Promise<ArrayBuffer>
A promise that resolves with the HMAC-SHA256 hash in ArrayBuffer format. |
| verify | ||||||||||||
verify(pubkey: string | JwkCertificate, data: string | Buffer, signature: string)
|
||||||||||||
|
Defined in src/crypto/crypto.ts:43
|
||||||||||||
|
Parameters :
Returns :
Promise<boolean>
|
import {BrowserCrypto} from './browser/crypto';
import {NodeCrypto} from './node/crypto';
export interface JwkCertificate {
kty: string;
alg: string;
use?: string;
kid: string;
n: string;
e: string;
}
export interface CryptoSigner {
update(data: string): void;
sign(key: string, outputFormat: string): string;
}
// Crypto interface will provide required crypto functions.
// Use `createCrypto()` factory function to create an instance
// of Crypto. It will either use Node.js `crypto` module, or
// use browser's SubtleCrypto interface. Since most of the
// SubtleCrypto methods return promises, we must make those
// methods return promises here as well, even though in Node.js
// they are synchronous.
export interface Crypto {
sha256DigestBase64(str: string): Promise<string>;
randomBytesBase64(n: number): string;
verify(
pubkey: string | JwkCertificate,
data: string | Buffer,
signature: string
): Promise<boolean>;
sign(
privateKey: string | JwkCertificate,
data: string | Buffer
): Promise<string>;
decodeBase64StringUtf8(base64: string): string;
encodeBase64StringUtf8(text: string): string;
/**
* Computes the SHA-256 hash of the provided string.
* @param str The plain text string to hash.
* @return A promise that resolves with the SHA-256 hash of the provided
* string in hexadecimal encoding.
*/
sha256DigestHex(str: string): Promise<string>;
/**
* Computes the HMAC hash of a message using the provided crypto key and the
* SHA-256 algorithm.
* @param key The secret crypto key in utf-8 or ArrayBuffer format.
* @param msg The plain text message.
* @return A promise that resolves with the HMAC-SHA256 hash in ArrayBuffer
* format.
*/
signWithHmacSha256(
key: string | ArrayBuffer,
msg: string
): Promise<ArrayBuffer>;
}
export function createCrypto(): Crypto {
if (hasBrowserCrypto()) {
return new BrowserCrypto();
}
return new NodeCrypto();
}
export function hasBrowserCrypto() {
return (
typeof window !== 'undefined' &&
typeof window.crypto !== 'undefined' &&
typeof window.crypto.subtle !== 'undefined'
);
}
/**
* Converts an ArrayBuffer to a hexadecimal string.
* @param arrayBuffer The ArrayBuffer to convert to hexadecimal string.
* @return The hexadecimal encoding of the ArrayBuffer.
*/
export function fromArrayBufferToHex(arrayBuffer: ArrayBuffer): string {
// Convert buffer to byte array.
const byteArray = Array.from(new Uint8Array(arrayBuffer));
// Convert bytes to hex string.
return byteArray
.map(byte => {
return byte.toString(16).padStart(2, '0');
})
.join('');
}