| 1 | # node-opcua-crypto
|
| 2 |
|
| 3 | NodeOPCUA Crypto is a powerful JavaScript module for handling security and cryptography for OPCUA. It's written in TypeScript and runs smoothly on Node.js and in the browser.
|
| 4 |
|
| 5 | [](https://www.npmtrends.com/node-opcua-crypto)
|
| 6 | [](https://www.npmjs.com/package/node-opcua-crypto?activeTab=versions)
|
| 7 | [](https://github.com/node-opcua/node-opcua-crypto/actions/workflows/main.yml)
|
| 8 | [](https://codeclimate.com/github/node-opcua/node-opcua-crypto)
|
| 9 | [](https://coveralls.io/github/node-opcua/node-opcua-crypto?branch=master)
|
| 10 | [](https://packagephobia.com/result?p=node-opcua-crypto)
|
| 11 | [](https://app.fossa.com/projects/custom%2B20248%2Fgithub.com%2Fnode-opcua%2Fnode-opcua-crypto?ref=badge_shield)
|
| 12 |
|
| 13 |
|
| 14 | ## Features
|
| 15 |
|
| 16 | * a comprehensive set of cryptographic functionalities.
|
| 17 | * supports both Node.js and browser environments.
|
| 18 | * compatible with TypeScript for robust, type-safe coding.
|
| 19 | * implements advanced security standards for OPCUA.
|
| 20 |
|
| 21 | ## Getting Started
|
| 22 |
|
| 23 | To use NodeOPCUA Crypto in your project, follow these steps:
|
| 24 |
|
| 25 | #### Installation
|
| 26 |
|
| 27 | ``` bash
|
| 28 | npm install nodeopcua-crypto
|
| 29 | ```
|
| 30 |
|
| 31 | ### Usage
|
| 32 |
|
| 33 | ``` bash
|
| 34 |
|
| 35 | import { generatePrivateKey, privateKeyToPEM, CertificatePurpose, createSelfSignedCertificate } from "./node-opcua-crypto.js";
|
| 36 |
|
| 37 | async function demonstratePrivateKeyAndSelfSignedCertificateCreation() {
|
| 38 |
|
| 39 | // create the Private Key
|
| 40 | const privateKey = await generatePrivateKey();
|
| 41 |
|
| 42 | // convert the private key to a PEM format
|
| 43 | const { privPem } = await privateKeyToPEM(privateKey);
|
| 44 |
|
| 45 | console.log(privPem);
|
| 46 |
|
| 47 | // create a self-sign certificate
|
| 48 | const { cert } = await createSelfSignedCertificate({
|
| 49 | privateKey,
|
| 50 | notAfter: new Date(2025, 1, 1),
|
| 51 | notBefore: new Date(2019, 1, 1),
|
| 52 | subject: "CN=Test",
|
| 53 | dns: ["DNS1", "DNS2"],
|
| 54 | ip: ["192.168.1.1"],
|
| 55 | applicationUri: "urn:HOSTNAME:ServerDescription",
|
| 56 | purpose: CertificatePurpose.ForApplication,
|
| 57 | });
|
| 58 | console.log(cert);
|
| 59 | }
|
| 60 | demonstratePrivateKeyAndSelfSignedCertificateCreation();
|
| 61 |
|
| 62 |
|
| 63 | ```
|
| 64 |
|
| 65 | Please refer to the examples directory for more specific use cases and comprehensive samples.
|
| 66 |
|
| 67 |
|
| 68 | ## Support
|
| 69 |
|
| 70 | For any inquiries or issues related to NodeOPCUA Crypto, you can contact us at contact@sterfive.com. Please note that priority support is available to NodeOPCUA Support Subscription members.
|
| 71 |
|
| 72 | ### Getting professional support
|
| 73 |
|
| 74 | NodeOPCUA PKI is developed and maintained by sterfive.com.
|
| 75 |
|
| 76 | To get professional support, consider subscribing to the node-opcua membership community:
|
| 77 |
|
| 78 | [](https://support.sterfive.com)
|
| 79 |
|
| 80 | or contact [sterfive](https://www.sterfive.com) for dedicated consulting and more advanced support.
|
| 81 |
|
| 82 | ## Contributing
|
| 83 |
|
| 84 | We appreciate contributions from the community. To contribute:
|
| 85 |
|
| 86 | * Fork the repository.
|
| 87 | * Create a new branch.
|
| 88 | * Commit your changes.
|
| 89 | * Submit a pull request.
|
| 90 | * Sign the CLA (Contributor Licence Agreement) form
|
| 91 |
|
| 92 | For more detailed instructions, refer to the CONTRIBUTING.md file.
|
| 93 |
|
| 94 | ## License
|
| 95 |
|
| 96 | NodeOPCUA Crypto is MIT licensed. See the LICENSE file for full license details.
|
| 97 |
|
| 98 | Copyright © 2023 Sterfive.com.
|
| 99 |
|
| 100 | ## Disclaimer
|
| 101 |
|
| 102 | NodeOPCUA Crypto is provided as-is, and while we strive to ensure its quality and security, Sterfive.com cannot be held liable for any damage caused directly or indirectly by the usage of this module.
|
| 103 |
|
| 104 | Please report any issues or vulnerabilities you find via the issue tracker.
|
| 105 |
|
| 106 | Thank you for considering NodeOPCUA Crypto for your OPCUA cryptography needs. We look forward to seeing what you build with i
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 | ## Supporting the development effort - Sponsors & Backers
|
| 111 |
|
| 112 | If you like `node-opcua-pki` and if you are relying on it in one of your projects, please consider becoming a backer and [sponsoring us](https://github.com/sponsors/node-opcua), this will help us to maintain a high-quality stack and constant evolution of this module.
|
| 113 |
|
| 114 | If your company would like to participate and influence the development of future versions of `node-opcua` please contact [sterfive](mailto:contact@sterfive.com).
|