mac 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bdaba057d3367392da97d8afd0cd5f1b5973686b97c3028757eb50f11d8f8c7
-  data.tar.gz: 78fcc37df2f60f67c8eeeddf28619931b0f55f0f61b9a72bc8dcc06234962d04
+  metadata.gz: 4877cf61c1e7df75ab432af4cd0e78278390f0ac8a61d2a59d8bd51208f75207
+  data.tar.gz: 8f622f976919faaabfbccd5bcc0dade0c3166eaf6750fb7bc02cfc02f0742d6f
 SHA512:
-  metadata.gz: 64fd0408a3848dcb93734bd80b230e6a2ff25f574bcb4e8289144332eb5cde51f9077da7eea7a96c89060c039a53b7ff9d5a4583fd9074820b18e83481fd961b
-  data.tar.gz: 0eba94242ffe369676dea2c52a2924410a5ef0d832990763bde0387de299603d539688e60551be6521d2e3290d8f56701b38a1130e62c911cb395b3474598616
+  metadata.gz: c881e11c07e4d9cd8045e5df534372998ef617ac8960f9b5340995ddd068370c0334ec290af510cf70653ec0b665ea5b686bb969b29854de4b7f13647828659c
+  data.tar.gz: 4575cac089235b92daa5ac448752e30da47e0525fd110b8eb00f91da428534233502886159bdf6683532df3c964975ede91d11534cc4496b1d77400d93a8f1f8

data/CHANGELOG.md

@@ -1,5 +1,7 @@
-## [Unreleased]
+## [1.0.1] - 2026-06-17
 
-## [0.1.0] - 2026-05-24
+- Add tests with 100% code coverage
 
-- Initial release
+## [1.0.0] - 2026-05-24
+
+- Initial release: Mac class with `sign` and `verify` methods.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2026 claudiob
+Copyright (c) 2026 HouseAccount
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,22 @@
-# Mac
+# Message Authentication Code (MAC) with SHA256 and signature
 
-TODO: Delete this and the text below, and describe your gem
+## Available methods
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mac`. To experiment with that code, run `bin/console` for an interactive prompt.
+Sign a message:
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+mac = Mac.sign message:, secret:
+mac.timestamp # => 1779489515999
+mac.signature # => 46f5297a94d0050ba6039bfcb12d6e4c1f955e39b34f98cf2bd5f9720b34ac49
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Verify a signed message:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+mac = Mac.new message:, secret:
+mac.signed? signature:, timestamp: # true
 ```
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/mac.
-
-## License
+## Tests
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Run `bundle exec ruby -Itest test/mac_test.rb`

data/lib/mac.rb

@@ -1,8 +1,39 @@
-# frozen_string_literal: true
+require 'base64'
+require 'openssl'
+require 'rack'
 
-require_relative "mac/version"
+# Provides methods to sign and verify timestamped messages with HMAC SHA256.
+class Mac
+  # Sets up a message to be signed/verified with a secret.
+  def initialize(message:, secret:, timed: true)
+    @message = message
+    @secret = secret
+    @timed = timed
+  end
 
-module Mac
-  class Error < StandardError; end
-  # Your code goes here...
+  # Sets up a message and calculates its current signature.
+  def self.sign(message:, secret:, timed: true, hexdigest: true)
+    new(message: message, secret: secret).tap do |mac|
+      mac.sign timestamp: (Time.now if timed), hexdigest: hexdigest
+    end
+  end
+
+  attr_reader :signature, :timestamp
+
+  # Returns whether the provided signature and timestamp match the signature of the message.
+  def signed?(signature:, timestamp: nil, hexdigest: true)
+    sign hexdigest: hexdigest, timestamp: timestamp
+    Rack::Utils.secure_compare @signature, signature
+  end
+
+  # Calculates the signature of the message.
+  def sign(timestamp: nil, hexdigest: true)
+    @timestamp = timestamp.to_i.to_s if timestamp
+    payload = [@timestamp, @message].compact.join '.'
+    @signature = if hexdigest
+      OpenSSL::HMAC.hexdigest 'SHA256', @secret, payload
+    else
+      Base64.strict_encode64(OpenSSL::HMAC.digest 'SHA256', @secret, payload)
+    end
+  end
 end

data/test/mac_test.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start { minimum_coverage 100 }
+require 'minitest/autorun'
+
+require_relative '../lib/mac'
+
+class MacTest < Minitest::Test
+  def test_with_hexdigest
+    mac = Mac.sign message: { foo: :bar }.to_json, secret: 'S3kr3t'
+    assert mac.signed? signature: mac.signature, timestamp: mac.timestamp
+  end
+
+  def test_without_hexdigest
+    mac = Mac.sign message: { foo: :bar }.to_json, secret: 'S3kr3t', hexdigest: false
+    assert mac.signed? signature: mac.signature, timestamp: mac.timestamp, hexdigest: false
+  end
+end

metadata

@@ -1,14 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: mac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - claudiob
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enhances OpenSSL::HMAC with timestamp.
 email:
 - claudiob@users.noreply.github.com
@@ -19,10 +89,8 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/mac.rb
-- lib/mac/version.rb
-- sig/mac.rbs
+- test/mac_test.rb
 homepage: https://github.com/HouseAccountEng/mac
 licenses:
 - MIT

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/mac/version.rb

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

data/sig/mac.rbs

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