sha3 0.2.2 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4ff3a34d0d9bce72c2ccbfb6a8ad81d9107f538ad2635cab15274c8661dcb71
+  data.tar.gz: 8fdab8312082afb9783faf1f9ec2136c5e8812a482fc1a6f0afded96cc9d64a8
+SHA512:
+  metadata.gz: e7a38d0f89905ad6f90fdcc4a29ad245aa5f82edfed8b227485623ad05bb591c9cf5493e93c9a93119197b801ef68217c5d165b61a27c9a66ad175343ab89f1e
+  data.tar.gz: 497c72e85ad814301adbb4f71c11f53e1434b9b660e70847eb0939bf30faa883d73215740cd425048978b9c1e71c8f2917eed1819a5ed15b12e74076253190a0

data/.gitignore

@@ -1,19 +1,234 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/c,clion,visualstudiocode,ruby
+# Edit at https://www.toptal.com/developers/gitignore?templates=c,clion,visualstudiocode,ruby
+
+### C ###
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+### CLion ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### CLion Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Ruby ###
 *.gem
 *.rbc
-*.rbx
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Ruby Patch ###
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/tasks.json
+!.vscode/launch.json
+*.code-workspace
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/c,clion,visualstudiocode,ruby

data/.travis.yml

@@ -1,15 +1,24 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7
-  - ruby-head
-  - rbx-18mode
-  - rbx-19mode
-  - ree
-  
-gemfile: Gemfile.ci
+arch:
+  - amd64
+  - arm64 
 
 branches:
   only:
-    - master
+    - master
+    - develop
+
+gemfile: Gemfile.ci
+
+language: ruby
+
+os:
+  - linux
+
+rvm:
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2

data/.yardopts

@@ -1 +1 @@
-lib/**/*.rb ext/**/_sha3.c --markup rdoc --title "sha3 Documentation" --protected
+lib/**/doc.rb lib/**/version.rb --markup rdoc --title "sha3 Documentation" --protected

data/ChangeLog.rdoc

@@ -9,3 +9,19 @@
 === 0.2.0 / 2012-11-1
 
 * SHA3::Digest: A proper ::Digest subclass.
+
+=== 0.2.2 / 2012-12-14
+
+* Added sub-class for each SHA3 supported bit-lengths (example: SHA3::Digest::SHA256). Minor bug fix.
+
+=== 0.2.3 / 2013-1-28
+
+* Added documentation file (decoupled form C source); refactored C source.
+
+=== 0.2.4 / 2013-5-20
+
+* Fixed instance copy validation code (YANKED)
+
+=== 0.2.5 / 2013-5-21
+
+* Fixed the fix to instance copy validation code.

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec

data/Gemfile.ci

@@ -1,8 +1,8 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec
 
-gem 'rubygems-tasks', '> 0.2'
-gem 'rake', '> 0.9'
-gem 'rspec', '~> 2.11'
-gem 'yard', '~> 0.8'
+gem 'rake'
+gem 'rspec'
+gem 'rubygems-tasks'
+gem 'yard'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Johanns Gregorian
+Copyright (c) 2015 Johanns Gregorian
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,120 @@
+# sha3  
+
+[![Gem Version](https://badge.fury.io/rb/sha3.svg)](https://badge.fury.io/rb/sha3) [![CI](https://secure.travis-ci.org/johanns/sha3.png)](https://secure.travis-ci.org/johanns/sha3) [![CodeClimate](https://codeclimate.com/github/johanns/sha3.png)](https://codeclimate.com/github/johanns/sha3)
+
+**SHA3 for Ruby** is a native (C) binding to SHA3 (Keccak FIPS 202) cryptographic hashing algorithm.
+
+- [Home](https://github.com/johanns/sha3#readme)
+- [Issues](https://github.com/johanns/sha3/issues)
+- [Documentation](http://rubydoc.info/gems/sha3/frames)
+
+## Warnings
+
+- Please do NOT use SHA3 to hash passwords -- use a slow hashing function instead (e.g.: `pbkdf2`, `argon2`, `bcrypt` or `scrypt`)
+- Version 1.0 introduces new API and is incompatible with previous versions (0.x).
+
+## Module details
+
+**SHA3::Digest**: A standard *Digest* _subclass_. The interface, and operation of this class are parallel to digest classes bundled with MRI-based Rubies (e.g.: **Digest::SHA2**, and **OpenSSL::Digest**).
+
+See [documentation for Ruby's **Digest** class for additional details](http://www.ruby-doc.org/stdlib-2.2.3/libdoc/digest/rdoc/Digest.html).
+
+## Installation
+
+```shell
+gem install sha3
+```
+
+## Usage
+
+```ruby
+require 'sha3'
+```
+
+Valid hash bit-lengths are: *224*, *256*, *384*, *512*.
+
+```ruby
+:sha224  :sha256  :sha384  :sha512
+
+# SHA3::Digest.new(224) is SHA3::Digest.new(:sha224)
+```
+
+Alternatively, you can instantiate using one of four sub-classes:
+
+```ruby
+SHA3::Digest::SHA224.new() # 224 bits
+SHA3::Digest::SHA256.new() # 256 bits
+SHA3::Digest::SHA384.new() # 384 bits
+SHA3::Digest::SHA512.new() # 512 bits
+```
+
+### Basics
+
+```ruby
+# Instantiate a new SHA3::Digest class with 256 bit length
+s = SHA3::Digest.new(:sha256)
+
+# OR #
+
+s = SHA3::Digest::SHA256.new()
+
+# Update hash state, and compute new value
+s.update "Compute Me"
+
+# << is an .update() alias
+s << "Me too"
+
+# Returns digest value in bytes
+s.digest
+# => "\xBE\xDF\r\xD9\xA1..."
+
+# Returns digest value as hex string
+s.hexdigest
+# => "bedf0dd9a15b647..."
+
+### Digest class-methods: ###
+
+SHA3::Digest.hexdigest(:sha224, "Hash me, please")
+# => "200e7bc18cd613..."
+
+SHA3::Digest::SHA384.digest("Hash me, please")
+# => "\xF5\xCEpC\xB0eV..."
+```
+
+### Hashing a file
+
+```ruby
+# Compute the hash value for given file, and return the result as hex
+s = SHA3::Digest::SHA224.file("my_fantastical_file.bin").hexdigest
+
+# Calling SHA3::Digest.file(...) defaults to SHA256
+s = SHA3::Digest.file("tests.sh")
+# => #<SHA3::Digest: a9801db49389339...>
+```
+
+## Development
+
+* Native build tools (e.g., GCC, Minigw, etc.)
+* Gems: rubygems-tasks, rake, rspec, yard
+
+### Testing
+
+Call ```rake``` to run the included RSpec tests.
+
+Only a small subset of test vectors are included in the source repository; however, the complete test vectors suite is available for download. Simply run the ```tests.sh``` shell script (available in the root of source directory) to generate full byte-length RSpec test files.
+
+  ```sh tests.sh```
+
+### Rubies
+
+Supported Ruby versions:
+
+  - MRI Ruby 2.4 - 3.0
+
+
+
+## Copyright
+
+Copyright (c) 2012 - 2020 Johanns Gregorian (https://github.com/johanns)
+
+**See LICENSE.txt for details.**