Files
Tiber365/node_modules/astro/dist/core/encryption.d.ts
2025-07-24 18:46:24 +02:00

37 lines
1.4 KiB
TypeScript

import type { CspAlgorithm } from '../types/public/index.js';
import { type CspHash } from './csp/config.js';
/**
* Creates a CryptoKey object that can be used to encrypt any string.
*/
export declare function createKey(): Promise<CryptoKey>;
/**
* See if the environment variable key ASTRO_KEY is set.
*/
export declare function hasEnvironmentKey(): boolean;
/**
* Get the environment variable key and decode it into a CryptoKey.
*/
export declare function getEnvironmentKey(): Promise<CryptoKey>;
/**
* Encodes a CryptoKey to base64 string, so that it can be embedded in JSON / JavaScript
*/
export declare function encodeKey(key: CryptoKey): Promise<string>;
/**
* Decodes a base64 string into bytes and then imports the key.
*/
export declare function decodeKey(encoded: string): Promise<CryptoKey>;
/**
* Using a CryptoKey, encrypt a string into a base64 string.
*/
export declare function encryptString(key: CryptoKey, raw: string): Promise<string>;
/**
* Takes a base64 encoded string, decodes it and returns the decrypted text.
*/
export declare function decryptString(key: CryptoKey, encoded: string): Promise<string>;
/**
* Generates an SHA-256 digest of the given string.
* @param {string} data The string to hash.
* @param {CspAlgorithm} algorithm The algorithm to use.
*/
export declare function generateCspDigest(data: string, algorithm: CspAlgorithm): Promise<CspHash>;