minisign 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c62dfae29350d2eeda4e52903ec728115a3cdd470abc9875cf91a5a43062933
-  data.tar.gz: dab08f56111bf6e04dceb379f8b939406479564d00d705cb04b7712b7b6db6a1
+  metadata.gz: 43e641548c51311a548098b0102d122dfd770db04384fc905d8fb133e0d90feb
+  data.tar.gz: 157e8e96644b65392e1f4f20f06976ec093ab275c2c2b83a2e4ec85b57282884
 SHA512:
-  metadata.gz: 710400d8d3b3c09692c4c34fb722793a73b1937a20489681d071857e350eec2a98f329b620f8099719e79b4a3fc9ed4c97d33ba5a10188ff028451895674493c
-  data.tar.gz: efdf25d72b0a3e73c3bb997b68a530de323353627d2a5b2bbf7a1d021e3a75734e593ebe5c66ad3b7381498a9f1d4d4bfd2841720497e844099090945bc4c603
+  metadata.gz: 3fda3b616d567b60fbd35e9fdb825bf6ac659a0cd93c80379a8c61004d7d6e3a02dbb05cddc76db7eef046224bad82a10e335c979d574f971ea7d89c945a65be
+  data.tar.gz: 45605deb3b08e44a9f49ffd7f64aea6c511c7e24dc6fef9951bb816ce08480ab8a6ef4041b1634cd910933f2b4b84e272207249b0a0d238e9ce17d7bd82da020

data/lib/minisign.rb

@@ -4,11 +4,23 @@ require 'ed25519'
 require 'base64'
 require 'openssl'
 
+# `minisign` is a rubygem for verifying {https://jedisct1.github.io/minisign minisign} signatures.
+# @author Jesse Shawl
 module Minisign
   # Parse a .minisig file's contents
   class Signature
     attr_reader :signature, :comment, :comment_signature
 
+    # @!attribute [r] signature
+    #   @return [String] the ed25519 verify key
+    # @!attribute [r] comment_signature
+    #   @return [String] the signature for the trusted comment
+    # @!attribute [r] comment
+    #   @return [String] the trusted comment
+
+    # @param str [String] The contents of the .minisig file
+    # @example
+    #   Minisign::Signature.new(File.read('test/example.txt.minisig'))
     def initialize(str)
       lines = str.split("\n")
       @signature = Base64.decode64(lines[1])[10..]
@@ -19,11 +31,23 @@ module Minisign
 
   # Parse ed25519 verify key from minisign public key
   class PublicKey
+    # Parse the ed25519 verify key from the minisign public key
+    #
+    # @param str [String] The minisign public key
+    # @example
+    #   Minisign::PublicKey.new('RWTg6JXWzv6GDtDphRQ/x7eg0LaWBcTxPZ7i49xEeiqXVcR+r79OZRWM')
     def initialize(str)
       @public_key = Base64.strict_decode64(str)[10..]
       @verify_key = Ed25519::VerifyKey.new(@public_key)
     end
 
+    # Verify a message's signature
+    #
+    # @param sig [Minisign::Signature]
+    # @param message [String] the content that was signed
+    # @return [String] the trusted comment
+    # @raise Ed25519::VerifyError on invalid signatures
+    # @raise RuntimeError on tampered trusted comments
     def verify(sig, message)
       blake = OpenSSL::Digest.new('BLAKE2b512')
       @verify_key.verify(sig.signature, blake.digest(message))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minisign
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jesse Shawl