OpenSecret SDK Documentation
Welcome to the official documentation for the OpenSecret SDK. This SDK enables you to build secure, privacy-preserving applications with end-to-end encryption, secure key management, and AI capabilities.
What is OpenSecret?
OpenSecret is a platform that provides advanced security and privacy features through hardware-based secure enclaves. It offers:
- End-to-end encryption for user data
- Cryptographic operations for secure key management and signing
- Secure key-value storage for encrypted user data
- Privacy-preserving AI integration with encryption to the GPU
- Remote attestation to verify server security guarantees
- Authentication solutions with flexible options including guest accounts
Key Features
- Hardware-based security: Leveraging AWS Nitro Enclaves for true hardware isolation
- Client-side encryption: Encrypt sensitive data before it leaves the user's device
- Deterministic key derivation: Derive secure keys from user authentication
- Guest accounts: Support anonymous users with full security features
- AI integration: Use AI models with end-to-end encryption for prompts and responses
- Remote attestation: Cryptographically verify the security of the server
- Comprehensive React SDK: Easy integration with React applications
Getting Started
To start using OpenSecret in your application:
- Register for an OpenSecret account
- Set up your project and get your client ID
- Install the SDK:
npm install @opensecret/react - Wrap your application with the
OpenSecretProvider - Use the
useOpenSecrethook to access SDK functionality
For more detailed instructions, check out the Getting Started Guide.
Documentation Sections
Guides
Step-by-step guides to help you implement specific features:
- Getting Started - Basic setup and usage
- Authentication - User authentication methods
- Key-Value Storage - Secure data storage
- Guest Accounts - Anonymous user support
- Cryptographic Operations - Keys, signing, and verification
- Data Encryption - Client-side encryption
- AI Integration - Encrypted AI capabilities
- Remote Attestation - Server security verification
- Third-Party Tokens - JWT token generation
API Reference
- TypeScript SDK - Complete reference documentation for all SDK classes, methods, and types
Installation
You can install the OpenSecret SDK using npm, yarn, or bun:
# Using npm
npm install @opensecret/react
# Using yarn
yarn add @opensecret/react
# Using bun
bun add @opensecret/react
Resources
Getting Help
If you encounter any issues or have questions about the SDK:
- Check the API Reference for detailed documentation
- Search the Discord for similar issues
- Contact us at [email protected]
Ready to get started? Register for an account or jump into the Getting Started Guide.