https://webcrypto.dev is a collection of applied cryptography and x.509 certificate related libraries by Peculiar Ventures, a technology company dedicated to making the process of building modern, usable, and secure applications and services easy.
With years of experience in this field, we have created a suite of popular libraries that make it easier for developers to integrate these technologies into their projects. These libraries are used by companies of all sizes, from large enterprises to small startups.
Some of the well-known companies that use our libraries include Microsoft, Google, CloudFlare, Facebook, WhatsApp, and many more.
This repository contains examples for some of our most popular libraries. Whether you’re a seasoned developer or just starting out, you’ll find that our libraries likley have everything you need to quickly integrate these technologies into your own projects.
So dive in and explore the different libraries available in this repository. We’re confident that you’ll find what you need to take your projects to the next level, just like many of the companies already using our libraries.
The cryptographic engines are the backbone of applications that utilize these technologies. To ensure code portability, we standardize on using the WebCrypto API and PKCS#11 to access well-established native cryptographic implementations. Our crypto engines simplify the integration process, making it convenient and effortless for you to add robust cryptographic functionality to your projects.
| Library | Description |
|---|---|
| @peculiar/webcrypto | A WebCrypto polyfill based on the NodeJS native crypto implementation that adds support for several cryptographic algorithms not included in the WebCrypto standard, enabling interoperability with existing systems that use those algorithms. |
| webcrypto-liner | A polyfill for the WebCrypto API that can be used when browsers do not support the API, allowing WebCrypto applications to work even if native implementations are not available. It also provides support for some algorithms that are needed for interoperability with existing systems that are not supported by the WebCrypto standard. |
| node-webcrypto-p11 | Provides a binding between the PKCS#11 API and the WebCrypto API, making it easy to add support for PKCS#11 to any application built around the WebCrypto API. |
| pkcs11js | Typescript/Javascript binding for PKCS#11, enables Node applications to interact with PKCS#11 implementations such as provided by smart cards and hardware security modules. |
| @pvpkcs11 | PKCS#11 implementation that makes it possible to access the operating system and browser implementations of cryptography and certificate stores from a single API, making it easy to build cross-platform applications that use these technologies. |
| Fortify | Fortify enables web applications to use smart cards, local certificate stores and do certificate enrollment. |
The ASN.1 and X.509 libraries are essential building blocks for many security-related applications, including web-based applications. That’s why we have created simple, easy-to-use libraries for working with these technologies in both browser and Node.js environments. These libraries make it convenient and effortless for you to add certificate handling capabilities to your projects, simplifying the integration process.
| Library | Description |
|---|---|
| asn1js | A low level Typescript library for parsing and serializing ASN.1 data structures. Chances are you should be using @peculiar/asn1 instead. |
| @peculiar/asn1 | An object-oriented Typescript library that provides support for parsing and serializing ASN.1 data structures. |
| pkijs | A low level Typescript library that provides support for working with X.509 certificates and related data structures. Chances are you should be using @peculiar/x509 instead. |
| @peculiar/x509 | An object-oriented Typescript library that provides a higher-level API for working with X.509 certificates and related data structures. |
The XML libraries are critical components for many security-related applications, including web-based applications. To simplify the process of working with XML, we have created libraries specifically designed for encoding, decoding, and signing XML data structures. These libraries simplify the integration process, making it convenient and effortless for you to add robust XML handling capabilities to your projects.
| Library | Description |
|---|---|
| xmldsigjs | A Typescript library that provides support for signing and validating XML data structures using the XML Digital Signature standard. |
| xadesjs | A Typescript library that provides support for signing and validating XML data structures using the XAdES (XML Advanced Electronic Signatures) standard. |
Our PDF libraries provide a convenient and easy-to-use solution for creating, manipulating, and working with PDF files, with a focus on signing and encryption scenarios. These libraries simplify the integration process and allow you to add PDF handling capabilities to your projects with ease.
| Library | Description |
|---|---|
| @peculizarventures/pdf-doc | A Typescript library for creating and working with a PDF files focused on signing, and encryption scenarios. |
| @peculizarventures/pdf-form-json | A PDF module enabling working with form elements through JSON. |
The end-to-end encryption protocols are essential building blocks for secure communication between parties. To simplify the process of establishing secure communication, we have created libraries specifically designed for key agreement. These libraries simplify the integration process, making it convenient and effortless for you to add robust end-to-end encryption capabilities to your projects.
| Library | Description |
|---|---|
| 2key‑ratchet | A library for secure communication between two parties over an unreliable network, based on the Double Ratchet protocol used in Signal. It provides forward secrecy and protects against message replay attacks. |
Our ACME libraries provide a comprehensive set of tools to automate the process of obtaining, configuring, and managing SSL/TLS certificates for your web applications. These libraries make it easy for developers to incorporate certificate management capabilities into their projects, and provide support for the latest ACME protocol features.
| Library | Description |
|---|---|
| @peculiar/acme-client | A Typescript library that provides a simple API for automating certificate issuance and management using the ACME protocol. |
Before you run the examples, you need to install the following:
yarn
npx ts-node ./path/to/example.ts
Note: Replace ./path/to/example.ts with the actual path to the example file that you want to run.
Examples:
npx ts-node ./src/crypto/peculiar_webcrypto/rsa_ssa.ts