Conversation
Co-authored-by: dshvvvshr <216969053+dshvvvshr@users.noreply.github.com>
Co-authored-by: dshvvvshr <216969053+dshvvvshr@users.noreply.github.com>
Co-authored-by: dshvvvshr <216969053+dshvvvshr@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds OpenSSL-from-source developer documentation and wires it into existing project docs, while cleaning up an invalid package.json merge artifact.
Changes:
- Adds
docs/OPENSSL_DEVELOPMENT.mdcovering cloning/building/testing OpenSSL and relating it to Node.js crypto usage. - Updates
README.mdandUNDER_PRESSURE_LOOMING.mdto reference the new OpenSSL guide and expand the crypto libraries section. - Removes duplicated/invalid JSON content from
package.json.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
docs/OPENSSL_DEVELOPMENT.md |
New OpenSSL development guide for cloning/building/testing and Node.js integration context |
README.md |
Adds a documentation link to the OpenSSL development guide |
UNDER_PRESSURE_LOOMING.md |
Introduces “Cryptographic Foundations” section and renumbers subsequent sections |
package.json |
Removes duplicated JSON content that was incorrectly embedded under engines |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| git clone git://git.openssl.org/openssl.git | ||
| cd openssl | ||
| ``` | ||
|
|
||
| Alternative HTTPS URL (if git:// protocol is blocked): | ||
| ```bash | ||
| git clone https://github.com/openssl/openssl.git | ||
| cd openssl | ||
| ``` |
There was a problem hiding this comment.
The guide recommends cloning via the git:// transport first. git:// is unauthenticated/unencrypted and is vulnerable to MITM; it’s also often blocked on corporate networks. Prefer https://github.com/openssl/openssl.git as the primary clone URL and mention git:// only as a legacy alternative (or remove it).
| # Install (optional) | ||
| sudo make install | ||
| ``` |
There was a problem hiding this comment.
sudo make install can overwrite the system OpenSSL and break OS/package-managed dependencies. Consider documenting a safer install workflow (e.g., configuring a custom --prefix/--openssldir, using DESTDIR, or avoiding install entirely and using the in-tree apps/openssl binary).
|
|
||
| ## Integration with Prime Security | ||
|
|
||
| Prime Security uses Node.js's `crypto` module, which typically links against the system's OpenSSL installation. To verify which OpenSSL version Node.js is using: |
There was a problem hiding this comment.
This statement is often inaccurate for Node.js: official Node binaries generally ship with a bundled OpenSSL rather than dynamically linking against the system installation (varies by distro/build flags). Please clarify the distinction (system-packaged Node vs upstream binaries, and when --shared-openssl applies).
| Prime Security uses Node.js's `crypto` module, which typically links against the system's OpenSSL installation. To verify which OpenSSL version Node.js is using: | |
| Prime Security uses Node.js's `crypto` module. Official Node.js binaries usually ship with a bundled OpenSSL, while some distribution-packaged Node.js builds may be compiled with `--shared-openssl` to use the system's OpenSSL instead. To see which OpenSSL version your current Node.js binary was built with: |
|
|
||
| To study or work with OpenSSL source code: | ||
| ```bash | ||
| git clone git://git.openssl.org/openssl.git |
There was a problem hiding this comment.
This snippet uses the git:// OpenSSL clone URL, which is unauthenticated/unencrypted. Prefer https://github.com/openssl/openssl.git here as well (and optionally mention git:// only as a legacy alternative).
| git clone git://git.openssl.org/openssl.git | |
| git clone https://github.com/openssl/openssl.git |
Adds documentation for developers working with OpenSSL source code for cryptographic research, custom builds, or implementation verification.
Changes
New guide:
docs/OPENSSL_DEVELOPMENT.mdDocumentation updates:
Fix: Removed duplicate JSON content in
package.json(pre-existing merge artifact)Example
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.