File Explorer

1/*2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.3 * SPDX-License-Identifier: Apache-2.0.4 */5 6/**7 * A module containing support for a variety of cryptographic operations.8 *9 * @packageDocumentation10 * @module crypto11 * @mergeTarget12 */13 14import crt_native from './binding';15import { NativeResource } from "./native_resource";16import { Hashable } from "../common/crypto";17 18export { Hashable } from "../common/crypto";19 20/**21 * Object that allows for continuous hashing of data.22 *23 * @internal24 */25abstract class Hash extends NativeResource {26    /**27     * Hash additional data.28     * @param data Additional data to hash29     */30    update(data: Hashable) {31        crt_native.hash_update(this.native_handle(), data);32    }33 34    /**35     * Completes the hash computation and returns the final hash digest.36     *37     * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.38     */39    finalize(truncate_to?: number): DataView {40        return crt_native.hash_digest(this.native_handle(), truncate_to);41    }42 43    constructor(hash_handle: any) {44        super(hash_handle);45    }46}47 48/**49 * Object that allows for continuous MD5 hashing of data.50 *51 * @category Crypto52 */53export class Md5Hash extends Hash {54    constructor() {55        super(crt_native.hash_md5_new());56    }57}58 59/**60 * Computes an MD5 hash. Use this if you don't need to stream the data you're hashing and can load the entire input61 * into memory.62 *63 * @param data The data to hash64 * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.65 *66 * @category Crypto67 */68export function hash_md5(data: Hashable, truncate_to?: number): DataView {69    return crt_native.hash_md5_compute(data, truncate_to);70}71 72/**73 * Object that allows for continuous SHA256 hashing of data.74 *75 * @category Crypto76 */77export class Sha256Hash extends Hash {78    constructor() {79        super(crt_native.hash_sha256_new());80    }81}82 83 84/**85 * Computes an SHA256 hash. Use this if you don't need to stream the data you're hashing and can load the entire input86 * into memory.87 *88 * @param data The data to hash89 * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.90 *91 * @category Crypto92 */93export function hash_sha256(data: Hashable, truncate_to?: number): DataView {94    return crt_native.hash_sha256_compute(data, truncate_to);95}96 97/**98 * Object that allows for continuous SHA1 hashing of data.99 *100 * @category Crypto101 */102 export class Sha1Hash extends Hash {103    constructor() {104        super(crt_native.hash_sha1_new());105    }106}107 108/**109 * Computes an SHA1 hash. Use this if you don't need to stream the data you're hashing and can load the entire input110 * into memory.111 *112 * @param data The data to hash113 * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.114 *115 * @category Crypto116 */117export function hash_sha1(data: Hashable, truncate_to?: number): DataView {118    return crt_native.hash_sha1_compute(data, truncate_to);119}120 121/**122 * Object that allows for continuous hashing of data with an hmac secret.123 *124 * @category Crypto125 */126abstract class Hmac extends NativeResource {127    /**128     * Hash additional data.129     *130     * @param data additional data to hash131     */132    update(data: Hashable) {133        crt_native.hmac_update(this.native_handle(), data);134    }135 136    /**137     * Completes the hash computation and returns the final hmac digest.138     *139     * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.140     */141    finalize(truncate_to?: number): DataView {142        return crt_native.hmac_digest(this.native_handle(), truncate_to);143    }144 145    constructor(hash_handle: any) {146        super(hash_handle);147    }148}149 150/**151 * Object that allows for continuous SHA256 HMAC hashing of data.152 *153 * @category Crypto154 */155export class Sha256Hmac extends Hmac {156    constructor(secret: Hashable) {157        super(crt_native.hmac_sha256_new(secret));158    }159}160 161/**162 * Computes an SHA256 HMAC. Use this if you don't need to stream the data you're hashing and can load the entire input163 * into memory.164 *165 * @param secret The key to use for the HMAC process166 * @param data The data to hash167 * @param truncate_to The maximum number of bytes to receive. Leave as undefined or 0 to receive the entire digest.168 *169 * @category Crypto170 */171export function hmac_sha256(secret: Hashable, data: Hashable, truncate_to?: number): DataView {172    return crt_native.hmac_sha256_compute(secret, data, truncate_to);173}174