tls/x509utils: SubjectPublicKeyBytes() and SHA1/SHA224/SHA256 shortcuts

amery commented 1 week ago

to index and compare public keys

Summary by CodeRabbit

New Features
- Introduced a new function to compute the SHA256 hash of the Subject Public Key.
- Enhanced functionality for handling Subject Public Keys with SHA1 and SHA224 hashing.
- Added functionality to extract raw bytes of the Subject Public Key.

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes introduce three new functions in the tls/x509utils/spki.go file for computing SHA1, SHA224, and SHA256 hashes of a Subject Public Key, alongside a function for extracting the raw bytes of the public key. The file now includes four functions: SubjectPublicKeySHA1, SubjectPublicKeySHA224, SubjectPublicKeySHA256, and SubjectPublicKeyBytes, all designed to handle public key extraction and hashing, with appropriate error handling.

Changes

File	Change Summary
tls/x509utils/spki.go	Added functions: `SubjectPublicKeySHA1`, `SubjectPublicKeySHA224`, `SubjectPublicKeySHA256`, and `SubjectPublicKeyBytes` for handling Subject Public Keys.

Possibly related PRs

95: The introduction of the x509utils subpackage includes foundational functions for handling X.509 certificates, which are directly related to the new hashing functions for Subject Public Keys in the main PR.

Suggested labels

enhancement, x/tls

Suggested reviewers

karasz

Poem

In the land of keys so bright,
Public secrets take their flight.
SHA1, SHA224, they dance and play,
SHA256 joins the fun today!
With every hash, a tale unfolds,
In the world of tls, where magic beholds! 🐇✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 80344b43c924def8bb64610f654e1299ffe84582 and a3c7757cacb0cbbda4edfd296d54f6186a8eab0f.

📒 Files selected for processing (1)

* tls/x509utils/spki.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* tls/x509utils/spki.go

--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepsource-io[bot] commented 1 week ago

Here's the code health analysis summary for commits 696ab33..a3c7757. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Shell	✅ Success		View Check ↗
Go	❌ Failure	❗ 3 occurences introduced	View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

amery commented 1 week ago

This pre-allocation might slightly improve performance, especially if this function is called frequently.

please explain the difference

amery commented 1 week ago

SubjectPublicKeySHA256() added

amery commented 1 week ago

47-68: LGTM with a potential optimization.

@coderabbitai won't both give me a preallocated zeroed struct?

coderabbitai[bot] commented 1 week ago

[!TIP] For best results, initiate chat on the files or code changes.

@amery, you're correct. Both approaches give you a preallocated zeroed struct, so there's no performance difference in this case. Thank you for pointing that out.

🔗 Analysis chain

🏁 Scripts executed

The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Display lines 47 to 68 of `tls/x509utils/spki.go` to analyze the code in question sed -n '47,68p' tls/x509utils/spki.go ``` Length of output: 615

✏️ Learnings added

``` Learnt from: amery URL: https://github.com/darvaza-proxy/x/pull/104 Timestamp: 2024-10-03T16:53:17.189Z Learning: In Go, declaring a struct variable using `var spki struct{...}` initializes a zeroed struct, so manual preallocation isn't necessary for performance optimization. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).

amery commented 1 week ago

wow, deepsource really hates sha1

karasz commented 1 week ago

wow, deepsource really hates sha1

It is there, nobody is forced to use it, and anyway it is a hash, who cares, could be even md4

amery commented 1 week ago

darvaza.org/x/tls@v0.2.2 tagged

darvaza-proxy / x