Adding IP Address support

[madflojo]

Fixes #8

This change adds IP Address support, adds some additional test cases for the full flow and fixes an issue found while adding client authentication tests.

Summary by CodeRabbit

• New Features

  • Added functionality to generate x509 certificates and keys with options to save them to files or temporary files.

• Bug Fixes

  • Improved error handling for invalid paths and insufficient permissions during certificate generation.

• Tests

  • Introduced comprehensive test cases for certificate generation and KeyPair configurations, ensuring robust validation for domains and IP addresses.

• Enhancements

  • Added KeyPairConfig struct for better X509 KeyPair generation and validation.
  • Enhanced ConfigureTLSConfig to return errors for better error handling.

[coderabbitai]

Walkthrough

The recent changes enhance the certificate generation process by adding support for IP addresses alongside domains. New functions facilitate generating certificates and keys, writing them to files or temporary files. Validation methods for domains and IP addresses are now available, ensuring the integrity of the generated certificates. Comprehensive tests have been added to validate these new features.

Changes

File	Change Summary
gencerts.go	Introduces functions for generating x509 certificates and keys, offering options for file output or temporary files.
gencerts_test.go	Adds test functions for certificate and key generation, covering various scenarios including error handling.
kpconfig.go	Introduces KeyPairConfig struct for X509 KeyPair generation with validation methods for domains and IP addresses.
kpconfig_test.go	Adds test cases for validating KeyPairConfig, encompassing domains, IP addresses, and error scenarios.
testcerts.go	Includes new and modified functions in CertificateAuthority and KeyPair structs to support IP addresses in certificates.

Assessment against linked issues

Objective	Addressed	Explanation
Support IPs as well (#8)	✅

In fields of code where bytes do flow,
Certificates and keys now grow.
For IPs and domains, they stand,
Secure connections, hand in hand.
With tests to guide and bugs to chase,
Our code evolves with grace and pace.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[madflojo]

@coderabbitai review

[coderabbitai]

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba61e88 and 34bdb40.

Files selected for processing (6)

• gencerts.go (1 hunks)
• gencerts_test.go (1 hunks)
• kpconfig.go (1 hunks)
• kpconfig_test.go (1 hunks)
• testcerts.go (3 hunks)
• testcerts_test.go (2 hunks)

Additional comments not posted (11)

kpconfig.go (2)

16-41: The KeyPairConfig struct and its validation method are well-implemented and handle the necessary checks for domain and IP address configurations.

---

43-54: The IPNetAddresses method correctly parses IP addresses and handles errors consistently with the rest of the module.

gencerts.go (3)

10-24: The GenerateCerts function is well-implemented, handling both specified domains and default CA behavior correctly.

---

26-37: The GenerateCertsToFile function correctly handles file operations and properly documents the behavior regarding existing files.

---

39-55: The GenerateCertsToTempFile function is correctly implemented, handling temporary file creation and error scenarios effectively.

kpconfig_test.go (2)

13-94: The TestKPConfigs function thoroughly tests various configuration scenarios for KeyPairConfig, ensuring that validation behaves as expected across different cases.

---

96-156: The TestKPIPAddresses function effectively tests the IP address parsing of KeyPairConfig, ensuring that both valid and invalid inputs are handled correctly.

gencerts_test.go (3)

9-14: The TestGeneratingCerts function correctly tests the basic functionality of certificate generation, ensuring error handling is properly implemented.

---

16-97: The TestGeneratingCertsToFile function comprehensively tests the file output of certificate generation, including handling of various error conditions effectively.

---

100-147: The TestGenerateCertsToTempFile function effectively tests the temporary file creation for certificates, ensuring that both success and error scenarios are handled correctly.

testcerts_test.go (1)

Line range hint 1-492: The tests in testcerts_test.go are comprehensive, covering both successful operations and error scenarios effectively. They provide good coverage for the functionalities introduced in the testcerts package.

[coderabbitai]

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 34bdb40 and ccd9603.

Files selected for processing (3)

• kpconfig.go (1 hunks)
• testcerts.go (3 hunks)
• testcerts_test.go (3 hunks)

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

• kpconfig.go
• testcerts_test.go

Additional comments not posted (3)

testcerts.go (3)

138-144: Ensure default IP addresses are included when no domains are specified.

This change effectively addresses the issue of supporting IP addresses in certificates, as described in the linked issue #8. The default inclusion of "127.0.0.1" and "::1" when no domains are provided is a good fallback.

---

146-186: Review the implementation of NewKeyPairFromConfig.

The method NewKeyPairFromConfig is well-implemented, handling the configuration validation and IP address extraction correctly. The error handling is robust, ensuring that any issues during the generation process are appropriately reported.

---

333-339: Review the error handling in ConfigureTLSConfig.

The ConfigureTLSConfig function now properly handles errors when creating the x509 key pair, which is a crucial improvement for robustness. Returning the modified tls.Config along with any potential error is a good practice.