certgen 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: bdaf8fdacad6518c7a0b679c0acb9bcf0a11329560716f31cc7884df154f0967
4
+ data.tar.gz: 846e35380bd6de70f8cdac267e07430ee10e0fadc8cef6085d64b4a2c0aac248
5
+ SHA512:
6
+ metadata.gz: 3eb3caa1797c237bd5e52d900ef19ced3975a2250a7031b9edb26ed2abc04acfb0f723df6a9c491a431fb31c275abc14a667e59bf84e4b284f3d17147738e2e6
7
+ data.tar.gz: 1611c486db2df826522229c0acdc88f2674ccbda6cb4b1fc574378d0ab95a6eb05f88787d613ff1a3c0c3bd0b054a65b0f273ec2fe17daf396bfd8ab90a93a04
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,8 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.1
3
+
4
+ Style/StringLiterals:
5
+ EnforcedStyle: double_quotes
6
+
7
+ Style/StringLiteralsInInterpolation:
8
+ EnforcedStyle: double_quotes
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2025-05-03
4
+
5
+ - Initial release
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 Rajan Bhattarai
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # Certgen
2
+
3
+ ![Ruby](https://img.shields.io/badge/Ruby-3.1%2B-red)
4
+ ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
5
+ ![Gem Version](https://img.shields.io/gem/v/certgen)
6
+
7
+ **Certgen** is a Ruby CLI tool to generate free SSL certificates from [Let's Encrypt](https://letsencrypt.org) using **DNS-01 verification**. Perfect for developers and site owners who use cPanel or manually managed servers and need to upload certificates themselves.
8
+
9
+ ## โœจ Features
10
+
11
+ - โœ… Generate valid SSL certificates via Let's Encrypt
12
+ - ๐ŸŒ Supports both base domains and `www.` subdomains automatically
13
+ - ๐Ÿ” Uses DNS-01 challenge (great for wildcard and shared hosting)
14
+ - ๐Ÿ“ Outputs `.crt`, `.pem`, and zipped bundles for easy upload
15
+ - ๐Ÿ”„ Stores reusable Let's Encrypt account key
16
+ - ๐Ÿ–ฅ๏ธ CLI interface for quick and easy usage
17
+
18
+ ## ๐Ÿ“ฆ Installation
19
+
20
+ ```bash
21
+ gem install certgen
22
+ ```
23
+
24
+ ## ๐Ÿš€ Usage
25
+
26
+ Run the CLI tool from your terminal:
27
+
28
+ ```bash
29
+ certgen --domain example.com --email user@example.com
30
+ ```
31
+
32
+ This will:
33
+ 1. Generate or reuse your Let's Encrypt account key
34
+ 2. Create DNS-01 challenge instructions
35
+ 3. Wait for your confirmation after DNS is set
36
+ 4. Generate the certificate files
37
+ 5. Zip them for upload to cPanel or any hosting service
38
+
39
+ ### ๐Ÿ”„ Example Output Files
40
+
41
+ After running, your certs will be saved in:
42
+
43
+ ```
44
+ ~/.ssl_output/example.com/
45
+ โ”œโ”€โ”€ certificate.crt
46
+ โ”œโ”€โ”€ private_key.pem
47
+ โ”œโ”€โ”€ ca_bundle.pem
48
+ โ””โ”€โ”€ cert_bundle.zip
49
+ ```
50
+
51
+ ## โœ๏ธ DNS Setup
52
+
53
+ You'll be prompted to create a DNS TXT record:
54
+
55
+ ```text
56
+ Record Name: _acme-challenge.example.com
57
+ Record Type: TXT
58
+ Record Value: abc123...
59
+ ```
60
+
61
+ Use [https://dnschecker.org](https://dnschecker.org) to confirm propagation before continuing.
62
+
63
+ ## ๐Ÿ”ง Development
64
+
65
+ Clone and run locally:
66
+
67
+ ```bash
68
+ git clone https://github.com/cdrrazan/certgen
69
+ cd certgen
70
+ bundle install
71
+ ```
72
+
73
+ Run the CLI locally:
74
+
75
+ ```bash
76
+ bin/certgen --domain example.com --email user@example.com
77
+ ```
78
+
79
+ ## โœ… Requirements
80
+
81
+ - Ruby >= 3
82
+ - DNS management access to create TXT records
83
+ - cPanel or similar manual SSL upload support
84
+
85
+ ## ๐Ÿ“„ License
86
+
87
+ This project is licensed under the MIT License. See the [LICENSE](https://github.com/cdrrazan/certgen/blob/main/LICENSE) file for details.
88
+
89
+ ## ๐Ÿ™Œ Author
90
+
91
+ **Rajan Bhattarai**
92
+ [GitHub](https://github.com/cdrrazan) โ€ข [Email](mailto:cdrrazan@gmail.com)
93
+
94
+ ---
95
+
96
+ ๐Ÿ›  Contributions and issues are welcome โ€” feel free to open a PR or issue on [GitHub](https://github.com/cdrrazan/certgen)!
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
data/exe/certgen ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "certgen"
5
+
6
+ Certgen::CLI.start
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ # lib/certgen/cli.rb
4
+
5
+ require "optparse"
6
+
7
+ module Certgen
8
+ class CLI
9
+ def self.start
10
+ options = {}
11
+
12
+ OptionParser.new do |opts|
13
+ opts.banner = "Usage: certgen [options]"
14
+
15
+ opts.on("-d", "--domain DOMAIN", "Domain name") { |v| options[:domain] = v }
16
+ opts.on("-e", "--email EMAIL", "Email address") { |v| options[:email] = v }
17
+ opts.on("-w", "--wildcard", "Request a wildcard certificate") { options[:wildcard] = true }
18
+ opts.on("-h", "--help", "Prints this help") do
19
+ puts opts
20
+ exit
21
+ end
22
+ end.parse!
23
+
24
+ unless options[:domain] && options[:email]
25
+ puts "Error: Domain and email are required."
26
+ exit 1
27
+ end
28
+
29
+ puts "[INFO] Starting certificate generation for #{options[:domain]}..."
30
+ Certgen.generate(
31
+ domain: options[:domain],
32
+ email: options[:email]
33
+ )
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,146 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "acme-client"
4
+ require "openssl"
5
+ require "fileutils"
6
+ require "zip"
7
+
8
+ module Certgen
9
+ class Generator
10
+ LETS_ENCRYPT_DIRECTORY = "https://acme-v02.api.letsencrypt.org/directory"
11
+ ACCOUNT_KEY_PATH = File.expand_path("~/.certgen/acme_account.key")
12
+
13
+ def initialize(domain:, email:)
14
+ @input_domain = domain
15
+ @email = email
16
+ @base_domain = domain.sub(/^www\./, "")
17
+ @domains = [@base_domain, "www.#{@base_domain}"].uniq
18
+ @output_dir = File.expand_path("~/.ssl_output/#{@base_domain}")
19
+ end
20
+
21
+ def run
22
+ ensure_account_key!
23
+ setup_client
24
+ create_output_directory
25
+ order_certificate
26
+ verify_dns_challenges
27
+ finalize_certificate
28
+ save_certificate_files
29
+ notify_user
30
+ end
31
+
32
+ private
33
+
34
+ def ensure_account_key!
35
+ FileUtils.mkdir_p(File.dirname(ACCOUNT_KEY_PATH))
36
+ if File.exist?(ACCOUNT_KEY_PATH)
37
+ puts "๐Ÿ” Loading existing ACME account key..."
38
+ @account_key = OpenSSL::PKey::RSA.new(File.read(ACCOUNT_KEY_PATH))
39
+ else
40
+ puts "๐Ÿ›  Generating new ACME account key..."
41
+ @account_key = OpenSSL::PKey::RSA.new(4096)
42
+ File.write(ACCOUNT_KEY_PATH, @account_key.to_pem)
43
+ end
44
+ end
45
+
46
+ def setup_client
47
+ @client = Acme::Client.new(
48
+ private_key: @account_key,
49
+ directory: LETS_ENCRYPT_DIRECTORY
50
+ )
51
+
52
+ begin
53
+ @client.new_account(contact: "mailto:#{@email}", terms_of_service_agreed: true)
54
+ rescue Acme::Client::Error::Malformed
55
+ puts "โœ… ACME account already registered."
56
+ end
57
+ end
58
+
59
+ def create_output_directory
60
+ FileUtils.mkdir_p(@output_dir)
61
+ end
62
+
63
+ def order_certificate
64
+ @order = @client.new_order(identifiers: @domains)
65
+ @authorizations = @order.authorizations
66
+ end
67
+
68
+ def verify_dns_challenges
69
+ @authorizations.each do |auth|
70
+ domain = auth.identifier["value"]
71
+ challenge = auth.dns
72
+
73
+ dns_record = "_acme-challenge.#{domain}"
74
+ puts "\n๐Ÿ“Œ Please create this DNS TXT record for domain: #{domain}"
75
+ puts "Record Name: #{dns_record}"
76
+ puts "Record Type: TXT"
77
+ puts "Record Value: #{challenge.record_content}"
78
+ puts "\nโš ๏ธ After adding it, wait for DNS to propagate (~1โ€“5 minutes)."
79
+ puts "๐Ÿ”Ž Use https://dnschecker.org to confirm itโ€™s live."
80
+ puts "Press ENTER when ready to continue..."
81
+ $stdin.gets
82
+
83
+ challenge.request_validation
84
+
85
+ while challenge.status == "pending"
86
+ puts "โณ Waiting for DNS validation for #{domain}..."
87
+ sleep 5
88
+ challenge.reload
89
+ end
90
+
91
+ unless challenge.status == "valid"
92
+ puts "โŒ DNS validation failed for #{domain}. Status: #{challenge.status}"
93
+ exit(1)
94
+ end
95
+
96
+ puts "โœ… Domain #{domain} successfully verified!"
97
+ end
98
+ end
99
+
100
+ def finalize_certificate
101
+ @certificate_key = OpenSSL::PKey::RSA.new(4096)
102
+ csr = Acme::Client::CertificateRequest.new(private_key: @certificate_key, names: @domains)
103
+ @order.finalize(csr: csr)
104
+
105
+ while @order.status == "processing"
106
+ sleep 1
107
+ @order.reload
108
+ end
109
+
110
+ return if @order.status == "valid"
111
+
112
+ puts "โŒ Failed to finalize order. Status: #{@order.status}"
113
+ exit(1)
114
+ end
115
+
116
+ def save_certificate_files
117
+ key_path = File.join(@output_dir, "private_key.pem")
118
+ crt_path = File.join(@output_dir, "certificate.crt")
119
+ ca_path = File.join(@output_dir, "ca_bundle.pem")
120
+
121
+ File.write(key_path, @certificate_key.to_pem)
122
+ File.write(crt_path, @order.certificate)
123
+ File.write(ca_path, @order.certificate) # Optional
124
+
125
+ zip_path = File.join(@output_dir, "cert_bundle.zip")
126
+ create_zip(zip_path, [key_path, crt_path, ca_path])
127
+ end
128
+
129
+ def create_zip(zip_path, files)
130
+ Zip::File.open(zip_path, Zip::File::CREATE) do |zipfile|
131
+ files.each do |file|
132
+ zipfile.add(File.basename(file), file) if File.exist?(file)
133
+ end
134
+ end
135
+ end
136
+
137
+ def notify_user
138
+ puts "\n๐ŸŽ‰ SSL certificate generated successfully for #{@domains.join(", ")}"
139
+ puts "๐Ÿ“ Files saved in: #{@output_dir}"
140
+ puts "- certificate.crt"
141
+ puts "- private_key.pem"
142
+ puts "- ca_bundle.pem"
143
+ puts "\n๐Ÿงพ You can now manually upload these files to your cPanel SSL/TLS section."
144
+ end
145
+ end
146
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Certgen
4
+ VERSION = "0.1.0"
5
+ end
data/lib/certgen.rb ADDED
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "certgen/version"
4
+ require "certgen/cli"
5
+ require "certgen/generator"
6
+
7
+ module Certgen
8
+ # Custom error class for all Certgen-specific errors
9
+ class Error < StandardError; end
10
+
11
+ # Main entry point for generating certificates
12
+ def self.generate(domain:, email:)
13
+ Certgen::Generator.new(
14
+ domain:,
15
+ email:
16
+ ).run
17
+ end
18
+ end
data/sig/certgen.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Certgen
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,62 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: certgen
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Rajan Bhattarai
8
+ bindir: exe
9
+ cert_chain: []
10
+ date: 2025-05-03 00:00:00.000000000 Z
11
+ dependencies: []
12
+ description: Certgen is a command-line Ruby gem that helps users generate free SSL
13
+ certificates from Let's Encrypt using DNS-01 verification. Ideal for users with
14
+ manual or cPanel-based hosting environments. Supports wildcard domains and reusable
15
+ account keys.
16
+ email:
17
+ - cdrrazan@gmail.com
18
+ executables:
19
+ - certgen
20
+ extensions: []
21
+ extra_rdoc_files: []
22
+ files:
23
+ - ".rspec"
24
+ - ".rubocop.yml"
25
+ - CHANGELOG.md
26
+ - CODE_OF_CONDUCT.md
27
+ - LICENSE.txt
28
+ - README.md
29
+ - Rakefile
30
+ - exe/certgen
31
+ - lib/certgen.rb
32
+ - lib/certgen/cli.rb
33
+ - lib/certgen/generator.rb
34
+ - lib/certgen/version.rb
35
+ - sig/certgen.rbs
36
+ homepage: https://github.com/cdrrazan/certgen
37
+ licenses:
38
+ - MIT
39
+ metadata:
40
+ allowed_push_host: https://rubygems.org
41
+ homepage_uri: https://github.com/cdrrazan/certgen
42
+ source_code_uri: https://github.com/cdrrazan/certgen
43
+ changelog_uri: https://github.com/cdrrazan/certgen/blob/main/CHANGELOG.md
44
+ rdoc_options: []
45
+ require_paths:
46
+ - lib
47
+ required_ruby_version: !ruby/object:Gem::Requirement
48
+ requirements:
49
+ - - ">="
50
+ - !ruby/object:Gem::Version
51
+ version: 3.1.0
52
+ required_rubygems_version: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - ">="
55
+ - !ruby/object:Gem::Version
56
+ version: '0'
57
+ requirements: []
58
+ rubygems_version: 3.6.2
59
+ specification_version: 4
60
+ summary: A Ruby CLI gem to generate free SSL certificates using Let's Encrypt with
61
+ DNS verification.
62
+ test_files: []