digest-base32 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa377043eb6395c1c5e4a291ead93e4fd4b6fc8d47f27e170062eea1681cfd34
+  data.tar.gz: 6c26617c5aac5d78856c95da27df1fb83fd5ae99c9fdebd801a1be2959c8b074
+SHA512:
+  metadata.gz: 41eced816a3b48b60e3ebdb51d91d55cf34dd16fff7cba2eaffe5fb297f15126fac25849036f9b75614cc15911eaee443807155633167cc7c3e20fef766f3e3d
+  data.tar.gz: fffb14ed6166fa9b0a60e2c2ebd7a84de74474e32e69e50a67dba434794f3ec7fffe0806ac45f191566d6cdad3977139b0abb0587ed01e6388707e3816944e1d

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 James Cook
+Copyright (c) 2020 Yauheni Dakuka
+
+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,44 @@
+Digest::Base32
+==============
+
+![Travis Build](https://travis-ci.com/ydakuka/digest-base32.svg?branch=master)
+
+Digest::Base32 is a Ruby native extension that wraps the base32 library found
+in [tpmtotop](https://github.com/mjg59/tpmtotp/blob/master/base32.h)
+
+Usage
+-----
+
+```ruby
+require 'digest/base32'
+
+encoded = Digest::Base32.encode('My string')
+decoded = Digest::Base32.decode(encoded)
+```
+
+Benchmark
+---------
+
+From Core i7 Macbook Pro (2014). Ruby 2.5.3
+```
+                                     user     system      total        real
+     base32 pure ruby (encode)   1.348343   0.000489   1.348832 (  1.349179)
+   base32 c extension (encode)   0.001638   0.000002   0.001640 (  0.001629)
+     base32 pure ruby (decode)   1.334840   0.000574   1.335414 (  1.335513)
+   base32 c extension (decode)   0.003613   0.000331   0.003944 (  0.003933)
+```
+
+Requirements
+------------
+
+* Ruby 2.3+
+* gcc/clang
+
+Running the test suite
+----------------------
+
+Run the test suite as follows:
+
+```
+rake test
+```

data/digest-base32.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__).freeze
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require 'digest/base32/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'digest-base32'
+  spec.version  = Digest::Base32::VERSION
+  spec.license  = 'MIT'
+  spec.homepage = 'https://github.com/ydakuka/digest-base32'
+  spec.summary  = 'Base32 Ruby C Extension'
+  spec.platform = Gem::Platform::RUBY
+
+  spec.authors = ['James Cook']
+
+  spec.description = <<-DESCRIPTION.split.join ' '
+    Ruby native extension for base32 encoding and decoding.
+  DESCRIPTION
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/ydakuka/digest-base32',
+    'source_code_uri' => 'https://github.com/ydakuka/digest-base32',
+    'bug_tracker_uri' =>
+      'https://github.com/ydakuka/digest-base32/issues',
+  }.freeze
+
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+
+  spec.files = Dir[
+    'README.md',
+    'LICENSE',
+    'Makefile',
+    'digest-base32.gemspec',
+    'ext/**/*.{c,h,rb}',
+    'lib/**/*.{rb}',
+  ]
+
+  spec.executables = spec.files.grep %r{^exe/}, &File.method(:basename)
+
+  spec.extensions << 'ext/digest/base32/extconf.rb'
+
+  spec.add_development_dependency 'base32',              '~> 0.3.2'
+  spec.add_development_dependency 'bundler',             '~> 2.1'
+  spec.add_development_dependency 'pry',                 '~> 0.12'
+  spec.add_development_dependency 'rake',                '~> 12.3'
+  spec.add_development_dependency 'rake-compiler',       '~> 1.1'
+  spec.add_development_dependency 'rspec',               '~> 3.9'
+  spec.add_development_dependency 'rubocop',             '~> 0.80'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+end

data/ext/digest/base32/base32.c

@@ -0,0 +1,221 @@
+/**
+ * base32 (de)coder implementation as specified by RFC4648.
+ *
+ * Copyright (c) 2010 Adrien Kunysz
+ *
+ * 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.
+ **/
+
+#include <assert.h>  // assert()
+#include <limits.h>  // CHAR_BIT
+
+#include "base32.h"
+
+/**
+ * Let this be a sequence of plain data before encoding:
+ *
+ *  01234567 01234567 01234567 01234567 01234567
+ * +--------+--------+--------+--------+--------+
+ * |< 0 >< 1| >< 2 ><|.3 >< 4.|>< 5 ><.|6 >< 7 >|
+ * +--------+--------+--------+--------+--------+
+ *
+ * There are 5 octets of 8 bits each in each sequence.
+ * There are 8 blocks of 5 bits each in each sequence.
+ *
+ * You probably want to refer to that graph when reading the algorithms in this
+ * file. We use "octet" instead of "byte" intentionnaly as we really work with
+ * 8 bits quantities. This implementation will probably not work properly on
+ * systems that don't have exactly 8 bits per (unsigned) char.
+ **/
+
+static size_t min(size_t x, size_t y)
+{
+	return x < y ? x : y;
+}
+
+static const unsigned char PADDING_CHAR = '=';
+
+/**
+ * Pad the given buffer with len padding characters.
+ */
+static void pad(unsigned char *buf, int len)
+{
+	for (int i = 0; i < len; i++)
+		buf[i] = PADDING_CHAR;
+}
+
+/**
+ * This convert a 5 bits value into a base32 character.
+ * Only the 5 least significant bits are used.
+ */
+static unsigned char encode_char(unsigned char c)
+{
+	static unsigned char base32[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
+	return base32[c & 0x1F];  // 0001 1111
+}
+
+/**
+ * Decode given character into a 5 bits value. 
+ * Returns -1 iff the argument given was an invalid base32 character
+ * or a padding character.
+ */
+static int decode_char(unsigned char c)
+{
+	char retval = -1;
+
+	if (c >= 'A' && c <= 'Z')
+		retval = c - 'A';
+	if (c >= '2' && c <= '7')
+		retval = c - '2' + 26;
+
+	assert(retval == -1 || ((retval & 0x1F) == retval));
+
+	return  retval;
+}
+
+/**
+ * Given a block id between 0 and 7 inclusive, this will return the index of
+ * the octet in which this block starts. For example, given 3 it will return 1
+ * because block 3 starts in octet 1:
+ *
+ * +--------+--------+
+ * | ......<|.3 >....|
+ * +--------+--------+
+ *  octet 1 | octet 2
+ */
+static int get_octet(int block)
+{
+	assert(block >= 0 && block < 8);
+	return (block*5) / 8;
+}
+
+/**
+ * Given a block id between 0 and 7 inclusive, this will return how many bits
+ * we can drop at the end of the octet in which this block starts. 
+ * For example, given block 0 it will return 3 because there are 3 bits
+ * we don't care about at the end:
+ *
+ *  +--------+-
+ *  |< 0 >...|
+ *  +--------+-
+ *
+ * Given block 1, it will return -2 because there
+ * are actually two bits missing to have a complete block:
+ *
+ *  +--------+-
+ *  |.....< 1|..
+ *  +--------+-
+ **/
+static int get_offset(int block)
+{
+	assert(block >= 0 && block < 8);
+	return (8 - 5 - (5*block) % 8);
+}
+
+/**
+ * Like "b >> offset" but it will do the right thing with negative offset.
+ * We need this as bitwise shifting by a negative offset is undefined
+ * behavior.
+ */
+static unsigned char shift_right(unsigned char byte, char offset)
+{
+	if (offset > 0)
+		return byte >>  offset;
+	else
+		return byte << -offset;
+}
+
+static unsigned char shift_left(unsigned char byte, char offset)
+{
+	return shift_right(byte, - offset);
+}
+
+/**
+ * Encode a sequence. A sequence is no longer than 5 octets by definition.
+ * Thus passing a length greater than 5 to this function is an error. Encoding
+ * sequences shorter than 5 octets is supported and padding will be added to the
+ * output as per the specification.
+ */
+static void encode_sequence(const unsigned char *plain, int len, unsigned char *coded)
+{
+	assert(CHAR_BIT == 8);  // not sure this would work otherwise
+	assert(len >= 0 && len <= 5);
+
+	for (int block = 0; block < 8; block++) {
+		int octet = get_octet(block);  // figure out which octet this block starts in
+		int junk = get_offset(block);  // how many bits do we drop from this octet?
+
+		if (octet >= len) { // we hit the end of the buffer
+			pad(&coded[block], 8 - block);
+			return;
+		}
+
+		unsigned char c = shift_right(plain[octet], junk);  // first part
+
+		if (junk < 0  // is there a second part?
+		&&  octet < len - 1)  // is there still something to read?
+		{
+			c |= shift_right(plain[octet+1], 8 + junk);
+		}
+		coded[block] = encode_char(c);
+	}
+}
+
+void base32_encode(const unsigned char *plain, size_t len, unsigned char *coded)
+{
+	// All the hard work is done in encode_sequence(),
+	// here we just need to feed it the data sequence by sequence.
+	for (size_t i = 0, j = 0; i < len; i += 5, j += 8) {
+		encode_sequence(&plain[i], (int)min(len - i, 5), &coded[j]);
+	}
+}
+
+static int decode_sequence(const unsigned char *coded, unsigned char *plain)
+{
+	assert(CHAR_BIT == 8);
+	assert(coded && plain);
+
+	plain[0] = 0;
+	for (int block = 0; block < 8; block++) {
+		int offset = get_offset(block);
+		int octet = get_octet(block);
+
+		int c = decode_char(coded[block]);
+		if (c < 0)  // invalid char, stop here
+			return octet;
+
+		plain[octet] |= shift_left(c, offset);
+		if (offset < 0) {  // does this block overflows to next octet?
+			assert(octet < 4);
+			plain[octet+1] = shift_left(c, 8 + offset);
+		}
+	}
+	return 5;
+}
+
+size_t base32_decode(const unsigned char *coded, unsigned char *plain)
+{
+	size_t written = 0;
+	for (size_t i = 0, j = 0; ; i += 8, j += 5) {
+		int n = decode_sequence(&coded[i], &plain[j]);
+		written += n;
+		if (n < 5)
+			return written;
+	}
+}

data/ext/digest/base32/base32.h

@@ -0,0 +1,66 @@
+/**
+ * base32 (de)coder implementation as specified by RFC4648.
+ *
+ * Copyright (c) 2010 Adrien Kunysz
+ *
+ * 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.
+ **/
+
+#ifndef __BASE32_H_
+#define __BASE32_H_
+
+#include <stddef.h>   // size_t
+
+/**
+ * Returns the length of the output buffer required to encode len bytes of
+ * data into base32. This is a macro to allow users to define buffer size at
+ * compilation time.
+ */
+#define BASE32_LEN(len)  (((len)/5)*8 + ((len) % 5 ? 8 : 0))
+
+/**
+ * Returns the length of the output buffer required to decode a base32 string
+ * of len characters. Please note that len must be a multiple of 8 as per
+ * definition of a base32 string. This is a macro to allow users to define
+ * buffer size at compilation time.
+ */
+#define UNBASE32_LEN(len)  (((len)/8)*5)
+
+/**
+ * Encode the data pointed to by plain into base32 and store the
+ * result at the address pointed to by coded. The "coded" argument
+ * must point to a location that has enough available space
+ * to store the whole coded string. The resulting string will only
+ * contain characters from the [A-Z2-7=] set. The "len" arguments
+ * define how many bytes will be read from the "plain" buffer.
+ **/
+void base32_encode(const unsigned char *plain, size_t len, unsigned char *coded);
+
+/**
+ * Decode the null terminated string pointed to by coded and write
+ * the decoded data into the location pointed to by plain. The
+ * "plain" argument must point to a location that has enough available
+ * space to store the whole decoded string.
+ * Returns the length of the decoded string. This may be less than
+ * expected due to padding. If an invalid base32 character is found
+ * in the coded string, decoding will stop at that point.
+ **/
+size_t base32_decode(const unsigned char *coded, unsigned char *plain);
+
+#endif

data/ext/digest/base32/digest-base32.c

@@ -0,0 +1,64 @@
+#include <stdlib.h>
+#include <ruby.h>
+#include <ruby/encoding.h>
+#include "base32.h"
+#include <ctype.h>
+
+static VALUE mDigest;
+static VALUE mDigest_cBase32;
+static VALUE eDecodeError;
+
+static VALUE
+digest_base32_encode(int argc, VALUE* argv, VALUE self)
+{
+  VALUE input;
+  const unsigned char* src;
+  size_t srclen;
+  rb_scan_args(argc, argv, "1", &input);
+
+  if (TYPE(input) != T_STRING) {
+    rb_raise(rb_eTypeError, "expected a String");
+  }
+
+  src = (unsigned char*) StringValuePtr(input);
+  srclen = BASE32_LEN(RSTRING_LEN(input));
+
+  unsigned char dest[srclen];
+  base32_encode(src, RSTRING_LEN(input), dest);
+
+  return rb_str_new((const char*) dest, srclen);
+}
+
+static VALUE
+digest_base32_decode(int argc, VALUE *argv, VALUE self)
+{
+  VALUE input;
+  const unsigned char* src;
+  size_t input_len, estimate_len;
+
+  rb_scan_args(argc, argv, "1", &input);
+
+  if (TYPE(input) != T_STRING) {
+    rb_raise(rb_eTypeError, "expected a String");
+  }
+
+  src = (unsigned char*) StringValuePtr(input);
+  input_len = RSTRING_LEN(input);
+  estimate_len = UNBASE32_LEN(input_len);
+  unsigned char out[estimate_len];
+
+  base32_decode(src, out);
+
+  return rb_str_new_cstr((const char*) out);
+}
+
+void
+Init_base32() {
+  mDigest = rb_define_module("Digest");
+  mDigest_cBase32 = rb_define_class_under(mDigest, "Base32", rb_cObject);
+
+  eDecodeError = rb_define_class_under(mDigest_cBase32, "DecodeError", rb_eStandardError);
+
+  rb_define_module_function(mDigest_cBase32, "encode", digest_base32_encode, -1);
+  rb_define_module_function(mDigest_cBase32, "decode", digest_base32_decode, -1);
+}

data/ext/digest/base32/extconf.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+dir_config('digest/base32')
+
+raise 'Could not find base32.h' unless find_header 'base32.h', __dir__
+
+create_makefile('digest/base32')

data/lib/digest/base32/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Digest
+  class Base32
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: digest-base32
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Cook
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Ruby native extension for base32 encoding and decoding.
+email: 
+executables: []
+extensions:
+- ext/digest/base32/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- digest-base32.gemspec
+- ext/digest/base32/base32.c
+- ext/digest/base32/base32.h
+- ext/digest/base32/digest-base32.c
+- ext/digest/base32/extconf.rb
+- lib/digest/base32/version.rb
+homepage: https://github.com/ydakuka/digest-base32
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ydakuka/digest-base32
+  source_code_uri: https://github.com/ydakuka/digest-base32
+  bug_tracker_uri: https://github.com/ydakuka/digest-base32/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Base32 Ruby C Extension
+test_files: []