Winter Auth

TypeScript library for biometric authentication and image metadata extraction for verifiable credentials.

Installation and Setup

Documentation

Local Dev

# Development
npm run dev

# Development for Documentation
# Needs to have the library builded locally, for that you can use

npm run build:watch

npm run dev:web

Environment Variables for /web

# AWS Rekognition
WAUTH_PROVIDER=aws
WAUTH_ACCESS_KEY=AKI...123
WAUTH_SECRET_KEY=vHe...c0m
WAUTH_AWS_REGION=us-east-1
#

Architecture

• Authorization Module: Face verification with AWS Rekognition -- Dual Mode: Direct (server) and proxy (client) operation modes
• Metadata Extractor: EXIF/GPS data extraction from images

Project Structure

src/
├── modules/
│   ├── authorization/          # Face verification
│   └── image-metadata/         # EXIF/GPS extraction
├── types/                      # TypeScript definitions
└── utils/                      # Shared utilities
│
tests/                          # Images to run build tests
└
web/                            # Documentation on Svelte
└

Documentation

Comprehensive documentation available at module level:

• Provider Configuration - AWS Rekognition configuration
• Metadata Extraction - EXIF/GPS data extraction guide

API Reference

Core Methods

Method	Description	Returns
compareByImage()	Compare two face images	Promise<ComparisonResult>
compareByLiveVideo()	Live video verification	Promise<VideoResult>
checkImageQuality()	Assess image quality	Promise<QualityResult>
extractImageMetadata()	Extract EXIF/GPS data	Promise<MetadataResult>

Testing

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Test specific module
npm run test:metadata

Repository

• GitHub: zenGate-Global/winter-auth
• Issues: Report bugs
• NPM: @zengate/winter-auth