apikey-generator

A TypeScript library to generate and validate API keys based on a provider secret and customizable time window.

Features

• Generate API keys based on a secret and a time window (hour, half-hour, day)
• Validate API keys for a given secret and time window
• Written in TypeScript, ready for npm publishing

Installation

npm install apikey-generator

Usage

import { generateApiKey, validateApiKey, TimeWindow } from "apikey-generator";

const secret = "your-provider-secret";

// Generate an API key for the current hour
const apiKey = generateApiKey(secret, "hour");

// Generate an API key for the current day
const dailyKey = generateApiKey(secret, "day");

// Validate an API key
const isValid = validateApiKey(secret, apiKey, "hour");
console.log("Is valid:", isValid); // true or false

API

generateApiKey(secret: string, window?: TimeWindow): string

• secret: The provider secret key
• window: 'hour' | 'half-hour' | 'day' (default: 'hour')
• Returns: API key as a 64-character hex string

validateApiKey(secret: string, apiKey: string, window?: TimeWindow): boolean

• secret: The provider secret key
• apiKey: The API key to validate
• window: 'hour' | 'half-hour' | 'day' (default: 'hour')
• Returns: true if valid, false otherwise

👨‍💻 Author

Omari Mohamed

• Role: Fullstack DevOps Developer
• GitHub: @MohamedOmari-Devops
• Email: [email protected]

License

MIT