Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.76 KB

README.md

File metadata and controls

59 lines (42 loc) · 2.76 KB

🔒 Identifiers from IANA's COSE Algorithms Registry

Reliability Rating Vulnerabilities Bugs Security Rating Maintainability Rating NPM Downloads


🚀 Features

  • Implements all assigined entries in IANA's COSE Algorithm that have a name and a value.
  • Simple exported constants, with no code to execute.
  • Some name transformations were required to make them valid JS identifiers.
    • For example, HMAC 256/64 becomes HMAC256_s_64 and ECDH-SS + HKDF-256 becomes ECDH_SS_and_HKDF_256.
  • Incudes JSDoc with a description as well as a note as to whether the value is currently deprecated or recommended.
  • It does not support reverse lookups. For example, there is not built in way to find the name for, for example, the value 0 (a reverse lookup would yield Reserved).

💻 Installation

To install the package, you can use npm or yarn:

npm install @apeleghq/cose-algorithms

or

yarn add @apeleghq/cose-algorithms

📚 Usage

Decrypting Data

import { encodings, decrypt } from '@apeleghq/cose-algorithms';

🤝 Contributing

We welcome any contributions and feedback! Please feel free to submit pull requests, bug reports or feature requests to our GitHub repository.

📜 License

This project is dedicated to the public domain, and you may do with it as you wish. Check out the LICENSE.txt file for more information.

If you download the full sources, note that some support files might (such as .prettierrc.cjs) might have a different license. In those cases, that license applies.