xml_signer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b96c5a8dafc5af9197fcc1da24a0914612466a72dad2052e4b1b5d89d630713
+  data.tar.gz: 338511fc4bf2892257d695c99dd90895cf278750d5224d750acef15200e9f3ae
+SHA512:
+  metadata.gz: 8d2c3fd25d8e8b88f06225a3b3baee4e9a5465c8acf95d0dc9476277a39854100dc4c37778f218869ef5ad314f0e0367f13020dfa9085c0d8941ef99b7ad2b3e
+  data.tar.gz: e9d83d1b325d244dcd1658005d869cdd2a47142477ecf40208bd7b53516925d13b20d939201cc5afb2f254a36fd8855e7422281ffe54a4d71632708a6e74526e

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Santhanakarthikeyan Selvaraj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 santhanakarthikeyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# XmlSigner
+
+XmlSigner is a Ruby gem for signing XML documents using a PKCS12 certificate, Nokogiri, and OpenSSL.
+
+## Installation
+
+```ruby
+gem 'xml_signer'
+```
+
+
+## Usage
+
+```ruby
+require 'xml_signer'
+
+pfx_file = 'path/to/your/certificate.pfx'
+pfx_password = 'your_password'
+
+signer = XmlSigner::Signer.new(pfx_file, pfx_password)
+
+xml_to_sign = <<-XML
+<Esign AuthMode="1" aspId="test" ekycIdType="A" responseSigType="pkcs7pdf" responseUrl="http://localhost:3000/response" sc="Y" ts="2024-07-01T19:29:42" txn="031ad56656beda1ab98c9debbd068d30" ver="2.1">
+  <Docs>
+    <InputHash docInfo="Trading Account opening form" hashAlgorithm="SHA256" id="1">be440a367d9c4d7357caff2b8bfa6640b60797c6cd41bd028b2067297c3ef317</InputHash>
+  </Docs>
+</Esign>
+XML
+
+signed_xml = signer.sign(xml_to_sign)
+puts signed_xml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/santhanakarthikeyan/xml_signer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/xml_signer/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the XmlSigner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xml_signer/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/xml_signer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module XmlSigner
+  VERSION = "0.1.0"
+end

data/lib/xml_signer/xml_signer.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'openssl'
+
+module XmlSigner
+  class Signer
+    def initialize(pfx_file, pfx_password)
+      @pfx_file = pfx_file
+      @pfx_password = pfx_password
+      @p12 = OpenSSL::PKCS12.new(File.read(@pfx_file), @pfx_password)
+      @cert = @p12.certificate
+      @key = @p12.key
+    end
+
+    def sign(xml_string)
+      doc = Nokogiri::XML(xml_string)
+      signature = generate_signature_element(doc)
+      doc.root.add_child(signature)
+      doc.to_xml
+    end
+
+    private
+
+    def generate_signature_element(doc)
+      signature = Nokogiri::XML::Node.new('Signature', doc)
+      signature.default_namespace = 'http://www.w3.org/2000/09/xmldsig#'
+
+      signed_info = generate_signed_info(doc)
+      signature.add_child(signed_info)
+
+      signature_value = generate_signature(signed_info)
+      append_signature(signature, signature_value)
+
+      signature
+    end
+
+    def generate_signed_info(doc)
+      signed_info = Nokogiri::XML::Node.new('SignedInfo', doc)
+
+      canonicalization_method = Nokogiri::XML::Node.new('CanonicalizationMethod', doc)
+      canonicalization_method['Algorithm'] = 'http://www.w3.org/TR/2001/REC-xml-c14n-20010315'
+      signed_info.add_child(canonicalization_method)
+
+      signature_method = Nokogiri::XML::Node.new('SignatureMethod', doc)
+      signature_method['Algorithm'] = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'
+      signed_info.add_child(signature_method)
+
+      reference = Nokogiri::XML::Node.new('Reference', doc)
+      reference['URI'] = ''
+
+      transforms = Nokogiri::XML::Node.new('Transforms', doc)
+      transform = Nokogiri::XML::Node.new('Transform', doc)
+      transform['Algorithm'] = 'http://www.w3.org/2000/09/xmldsig#enveloped-signature'
+      transforms.add_child(transform)
+      reference.add_child(transforms)
+
+      digest_method = Nokogiri::XML::Node.new('DigestMethod', doc)
+      digest_method['Algorithm'] = 'http://www.w3.org/2000/09/xmldsig#sha1'
+      reference.add_child(digest_method)
+
+      # Digest the entire document excluding the Signature element
+      canonized_xml = doc.canonicalize(Nokogiri::XML::XML_C14N_1_0)
+      digest_value = OpenSSL::Digest::SHA1.new(canonized_xml).base64digest
+      digest_value_node = Nokogiri::XML::Node.new('DigestValue', doc)
+      digest_value_node.content = digest_value
+      reference.add_child(digest_value_node)
+
+      signed_info.add_child(reference)
+      signed_info
+    end
+
+    def generate_signature(signed_info)
+      # Canonicalize the SignedInfo node with the correct context
+      temp_doc = Nokogiri::XML::Document.new
+      temp_doc.root = signed_info.dup
+      canonized_signed_info = temp_doc.canonicalize(Nokogiri::XML::XML_C14N_1_0)
+      signature = @key.sign(OpenSSL::Digest::SHA1.new, canonized_signed_info)
+      Base64.encode64(signature).delete("\n")
+    end
+
+    def append_signature(signature, signature_value)
+      doc = signature.document
+      signature_value_node = Nokogiri::XML::Node.new('SignatureValue', doc)
+      signature_value_node.content = signature_value
+      signature.add_child(signature_value_node)
+
+      key_info = Nokogiri::XML::Node.new('KeyInfo', doc)
+      x509_data = Nokogiri::XML::Node.new('X509Data', doc)
+
+      x509_certificate = Nokogiri::XML::Node.new('X509Certificate', doc)
+      x509_certificate.content = Base64.encode64(@cert.to_der).delete("\n")
+      x509_data.add_child(x509_certificate)
+
+      x509_subject_name = Nokogiri::XML::Node.new('X509SubjectName', doc)
+      x509_subject_name.content = format_subject(@cert.subject)
+      x509_data.add_child(x509_subject_name)
+
+      key_info.add_child(x509_data)
+      signature.add_child(key_info)
+
+      doc.root.add_child(signature)
+    end
+
+    def format_subject(subject)
+      subject.to_a.map { |name, value, _| "#{name}=#{value}" }.join(', ')
+    end
+  end
+end

data/lib/xml_signer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "xml_signer/version"
+require_relative "xml_signer/xml_signer"
+
+module XmlSigner
+  class Error < StandardError; end
+end

data/sig/xml_signer.rbs

@@ -0,0 +1,4 @@
+module XmlSigner
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: xml_signer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- santhanakarthikeyan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This gem provides functionality to sign XML using a PKCS12 certificate,
+  Nokogiri, and OpenSSL
+email:
+- santhanakarthikeyan@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xml_signer.rb
+- lib/xml_signer/version.rb
+- lib/xml_signer/xml_signer.rb
+- sig/xml_signer.rbs
+homepage: https://rubygems.org/gems/xml_signer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/xml_signer
+  source_code_uri: https://github.com/santhanakarthikeyan/xml_signer
+  changelog_uri: https://github.com/santhanakarthikeyan/xml_signer/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A gem to sign XML using PKCS12 certificate
+test_files: []