sm2-crypto 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebb33e26c40b2f9d1dfd6b8702229df7ebfa769511317411da4174aec17afe2d
-  data.tar.gz: f219b9e73087c7e63b1a052966fc9b1312ec9b96a6988e7f1ec260e1128fccb3
+  metadata.gz: 67cba5e7c65f8ade66d34435da5f014512145d0310a03667a9fd7d1db871e70f
+  data.tar.gz: a60996ef1a495c1d774573ad78c0333c6a8860fa5075542502bde1f51265e5b2
 SHA512:
-  metadata.gz: 1210024cac3e374a4937e517ce4c886b34cdc2f42a39ae9da592df61a04c8c001d406342b99e2e8df58b3c301597d6caf78356bb575ca38f7fa3ec2028085e2a
-  data.tar.gz: 03fe97c1b2ddd1368b35cdbf6a65da751ae2ed949f554a2ca84db6101fa4192bf58035794e71f41d770967c4320e8c82c161e7cc400b6700585f541a3f91e4d9
+  metadata.gz: a0c4755fb05added355578173cababf90d68db821c75607fb556effccfb5594ad72433c72e947c117f0a3f4349778666da6ad6e96798b8f89f02346ba7bb10e9
+  data.tar.gz: 905491384a247b2ba18e9b59528f59459496c438292ccd83c3a6c9d1cff4a99c306c8f8bd6c5476e91c137960bb1e5ccd3953c0492cb6468463f051bf8d19aba

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.3] - 2025-09-03
+
+- Breaking change: rename `sm2_crypto` to `sm2-crypto` to fix rails autoload
+
+## [0.2.2] - 2025-03-26
+
+- Add ASN.1 DER format for sm2 sign and verify
+
+## [0.2.0] - 2023-04-21
+
+- Add sm2 sign and verify support
+
 ## [0.1.0] - 2023-03-27
 
 - Initial release

data/Gemfile

@@ -5,5 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sm2-crypto.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
+gem "rake", "~> 13.2"
+gem "minitest", "~> 5.25"
+# for ruby 3.4 +
+gem "base64", '~> 0.2'

data/README.md

@@ -33,7 +33,7 @@ $ gem install sm2-crypto
 ### Encrypt and Decrypt
 
 ```ruby
-require 'sm2_crypto'
+require 'sm2-crypto'
 
 # Generate key pair
 keypair = OpenSSL::PKey::EC.generate("SM2")
@@ -59,11 +59,17 @@ sign = SM2Crypto.sign(private_key, message)
 # verify signatrue
 SM2Crypto.verify(public_key, message, sign)
 
-user_id = "31323334353637383132333435363738" # user_id should be a hex string
+# user_id should be a hex string, default: "31323334353637383132333435363738" which is equal to utf-8 string: "1234567812345678"
+user_id = "31323334353637383132333435363738"
 # sign with hash and user_id
 sign = SM2Crypto.sign(private_key, message, sm3_hash: true, user_id: user_id)
 # verify with hash and user_id
 SM2Crypto.verify(public_key, message, sign, sm3_hash: true, user_id: user_id)
+
+# sign with ASN.1 DER format output
+sign = SM2Crypto.sign(private_key, message, asn1: true)
+# verify signatrue
+SM2Crypto.verify(public_key, message, sign, asn1: true)
 ```
 
 ### Get Public Key from Private Key

data/lib/{sm2_crypto.rb → sm2-crypto.rb}

@@ -3,6 +3,8 @@
 require "openssl"
 
 module SM2Crypto
+  VERSION = "0.3.0"
+
   module_function
 
   # Key Derived Function
@@ -101,9 +103,10 @@ module SM2Crypto
   # @param private_key [String] private key, format: binary string
   # @param data [String]
   # @param sm3_hash [Boolean], option to sign with sm3 hash, default: false
-  # @param user_id [String], format: hex string, default: "31323334353637383132333435363738"
+  # @param user_id [String], format: hex string, default: "31323334353637383132333435363738" which is equal to utf-8 str "1234567812345678"
+  # @param asn1 [Boolean], option to return asn.1 der format signature, default: false
   # @return [String] signature, format: hex string
-  def sign(private_key, data, sm3_hash: false, user_id: "31323334353637383132333435363738")
+  def sign(private_key, data, sm3_hash: false, user_id: "31323334353637383132333435363738", asn1: false)
     data = data.unpack1("a*") unless data.ascii_only?
     if sm3_hash
       public_key = get_public_key(private_key)
@@ -130,7 +133,11 @@ module SM2Crypto
       s = ((one + da).mod_inverse(n) * (k - (r * da))).to_i % n.to_i
     end
 
-    r.to_s(16).rjust(64, "0") + s.to_s(16).rjust(64, "0")
+    if asn1
+      OpenSSL::ASN1::Sequence.new([OpenSSL::ASN1::Integer.new(r), OpenSSL::ASN1::Integer.new(s)]).to_der.unpack1("H*")
+    else
+      r.to_s(16).rjust(64, "0") + s.to_s(16).rjust(64, "0")
+    end
   end
 
   # verify the signature with public_key
@@ -140,17 +147,28 @@ module SM2Crypto
   # @param signature [String], hex string
   # @param sm3_hash [Boolean], option to sign with sm3 hash, default: false
   # @param user_id [String], format: hex string, default: "31323334353637383132333435363738"
+  # @param asn1 [Boolean], option to verify asn.1 der format signature, default: false
   # @return [Boolean] verify result
-  def verify(public_key, data, signature, sm3_hash: false, user_id: "31323334353637383132333435363738")
-    return false if signature.size != 128
+  def verify(public_key, data, signature, sm3_hash: false, user_id: "31323334353637383132333435363738", asn1: false)
+    if asn1
+      return false if signature.size < 136
+
+      # parse asn1 der format hex string signature
+      der_seq = OpenSSL::ASN1.decode([signature].pack("H*"))
+      r = der_seq.value[0].value
+      s = der_seq.value[1].value
+    else
+      return false if signature.size != 128
+
+      r = OpenSSL::BN.new(signature[0, 64], 16)
+      s = OpenSSL::BN.new(signature[64, 64], 16)
+    end
 
     public_key = "\x04#{public_key}" if public_key.size == 64 && public_key[0] != "\x04"
     data = data.unpack1("a*") unless data.ascii_only?
     if sm3_hash
       data = OpenSSL::Digest.digest("SM3", za(public_key, user_id) + data)
     end
-    r = OpenSSL::BN.new(signature[0, 64], 16)
-    s = OpenSSL::BN.new(signature[64, 64], 16)
     n = OpenSSL::BN.new("FFFFFFFEFFFFFFFFFFFFFFFFFFFFFFFF7203DF6B21C6052B53BBF40939D54123", 16)
     e = OpenSSL::BN.new(data, 2)
 

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sm2-crypto
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Seekr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
+date: 2025-09-03 00:00:00.000000000 Z
+dependencies: []
 description: sm2-crypto is an implementation of the SM2 encryption and decryption
   algorithm in pure Ruby based on the OpenSSL
 email:
@@ -48,12 +20,10 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/sm2_crypto.rb
-- sm2-crypto.gemspec
+- lib/sm2-crypto.rb
 homepage: https://github.com/numbcoder/sm2-crypto
 licenses:
 - MIT
@@ -76,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: An SM2 cryptographic algorithm encryption and decryption library for Ruby

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sm2-crypto (0.2.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.18.0)
-    rake (13.0.6)
-
-PLATFORMS
-  arm64-darwin-22
-  x86_64-linux
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  sm2-crypto!
-
-BUNDLED WITH
-   2.4.6

data/sm2-crypto.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-Gem::Specification.new do |spec|
-  spec.name = "sm2-crypto"
-  spec.version = "0.2.1"
-  spec.authors = ["Seekr"]
-  spec.email = ["wzhao23@gmail.com"]
-
-  spec.summary = "An SM2 cryptographic algorithm encryption and decryption library for Ruby"
-  spec.description = "sm2-crypto is an implementation of the SM2 encryption and decryption algorithm in pure Ruby based on the OpenSSL"
-  spec.homepage = "https://github.com/numbcoder/sm2-crypto"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
-
-  spec.metadata["rubygems_mfa_required"] = "true"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "minitest", ">= 5.0"
-  spec.add_development_dependency "rake", ">= 13.0"
-end