RubyGems - u2fhost - Versions diffs - 1.0.0 - Mend

u2fhost 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 523083bccf9953e6ef6423ee772314a2d9b9291ef958fc03a5fc1474c68ff75c
+  data.tar.gz: ee83bcb3780b79a78010f9dc763626d9a03e201edb0af51f1d72aa2ce5a99141
+SHA512:
+  metadata.gz: cf4ba5b42fb8d7d8a69574a6ab50887c0c04b4ce56a3530c4a84ef67fe00782525faf639f6140e064030a0ae733afb31f9f32fba44c077ad057e0b11475d8661
+  data.tar.gz: 5ab6f77518d0d146de20c86714b08e05cfc4e3f614a38a39331682c4528a170e219adaf591a361e44b842f328a6804b1c99706f3470fdad1369c6c338899bea1

data/.circleci/Dockerfile ADDED

@@ -0,0 +1,62 @@
+FROM circleci/ruby:2.6.3-stretch
+MAINTAINER Xaptum
+LABEL version="1.0"
+LABEL description="Base image for ruby-u2f-host build"
+ENV U2F_HOST libu2f-host-1.1.10
+ARG DEBIAN_FRONTEND=noninteractive
+USER root
+# make Apt non-interactive
+RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
+  && echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci \
+	&& sed -i "s%{GPG_EXE}\")' --%{GPG_EXE}\")' --batch --%g" /usr/bin/apt-key
+# Install dirmngr and gnugpg
+RUN apt-get update  && \
+	apt-get install -y --no-install-recommends \
+	gnupg                                      \
+	dirmngr
+# Install base packages
+RUN apt-get update  && \
+	apt-get install -y --no-install-recommends \
+	apt-utils                                  \
+	xz-utils                                   \
+	curl                                       \
+	autoconf                                   \
+	automake                                   \
+	libtool                                    \
+	pkg-config                                 \
+	libjson-c-dev                              \
+	make                                       \
+	libhidapi-hidraw0                          \
+	g++                                        \
+	git                                        \
+	libhidapi-dev &&                           \
+	rm -rf /var/lib/apt/lists/*
+# Install libu2f-host
+ADD https://developers.yubico.com/libu2f-host/Releases/$U2F_HOST.tar.xz /root/
+RUN tar -xvf /root/$U2F_HOST.tar.xz -C /root
+WORKDIR /root/$U2F_HOST
+RUN ./configure
+RUN make check && make install
+RUN gem install bundler
+RUN gem install bump
+RUN gem install geminabox
+RUN gem install rufo
+# Cleanup
+RUN apt-get update && \
+	rm -rf /var/lib/apt/lists/* && \
+	rm -rf /root/$U2F_HOST && \
+	rm -rf /root/U2F_HOST.tar.xz
+USER circleci
+WORKDIR /home/circleci

data/.circleci/build.sh ADDED

@@ -0,0 +1,74 @@
+#!/bin/bash
+set -e
+RELEASE_VSN_REGEX=[0-9]+.[0-9]+.[0-9]+$
+PRE_VSN_REGEX=[0-9]+.[0-9]+.[0-9]+.pre.[a-z]+$
+branch() {
+    # Check if branch name comes for drone
+    local BRANCH=${CIRCLE_BRANCH}
+    # Finally take from git
+    if [ "X$BRANCH" == X ]; then
+	BRANCH=$(git rev-parse --abbrev-ref HEAD)
+    fi
+    echo -n "${BRANCH}"
+}
+version() {
+    local VERSION=$(make version | sed -e 's/[cC]urrent [vV]ersion:\s*//')
+    echo -n "${VERSION}"
+}
+match() {
+    if [[ ! $1 =~ $2 ]]; then
+	exit -1
+    else
+	exit 0
+    fi
+}
+push_gem() {
+    local type=$1
+    local vsn=$2
+    local regex=$3
+    if [[ ${vsn} =~ ${regex} ]]; then
+	gem push pkg/u2fhost-${vsn}.gem
+    else
+	echo "Cannot publish ${type} for ${vsn}"
+    fi
+}
+deploy_gem() {
+    if [ "X${CIRCLE_TAG}" == X ]; then
+	# Tag is empty. Ensure pre-relase
+	local pre=$(version | sed -e 's/-/\.pre\./')
+	push_gem 'PRE-RELEASE' ${pre} ${PRE_VSN_REGEX}
+    else
+	local vsn=$(version)
+	push_gem 'RELEASE' ${vsn} ${RELEASE_VSN_REGEX}
+    fi
+}
+main() {
+    case $1 in
+	deploy)
+	    if [ "X${CIRCLE_PROJECT_USERNAME}" == Xxaptum ]; then
+		deploy_gem
+	    else
+		echo "Cannot deploy gem for ${CIRCLE_PROJECT_USERNAME}"
+	    fi
+	    ;;
+	*)
+	    # Fail build
+	    exit -1
+	    ;;
+    esac
+}
+main $@

data/.circleci/config.yml ADDED

@@ -0,0 +1,108 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+# aliases
+release_steps: &release_steps
+  steps:
+    - checkout
+    - run:
+        name: install dependencies
+        command: |
+          make bundle
+    - run:
+        name: Setup Rubygems
+        command: |
+          .circleci/setup-rubygems.sh
+    - attach_workspace:
+        at: ~/u2fhost
+    - run:
+        name: deploy to rubygems
+        command: |
+          .circleci/build.sh deploy
+# Jobs
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: xaptumeng/u2fhost-build
+    working_directory: ~/u2fhost
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: |
+            make bundle
+      - run:
+          name: Check code format
+          command: |
+            make check-format
+      - run:
+          name: build package
+          command: |
+            make build
+      # Perisist the gem to workspace
+      - persist_to_workspace:
+          root: ~/u2fhost
+          paths:
+            - pkg
+  # release job
+  release:
+    docker:
+      - image: xaptumeng/u2fhost-build
+    working_directory: ~/u2fhost
+    <<: *release_steps
+  # pre-release job
+  pre_release:
+    docker:
+      - image: xaptumeng/u2fhost-build
+    working_directory: ~/u2fhost
+    <<: *release_steps
+# Workflows
+workflows:
+  version: 2
+  u2fhost-workflow:
+    jobs:
+      - build:
+          context: gems.xaptum.xyz
+          filters:
+            branches:
+              only: /.*/
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+      - release:
+          context: gems.xaptum.xyz
+          requires:
+            - build
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+      - pre_release:
+          context: gems.xaptum.xyz
+          requires:
+            - build
+          filters:
+            branches:
+              only: master

data/.circleci/setup-rubygems.sh ADDED

@@ -0,0 +1,3 @@
+mkdir -p ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.gitignore ADDED

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# rspec failure tracking
+.rspec_status
+*.so
+*.bundle
+*.dylib
+.DS_Store
+foo
+bar

data/.rspec ADDED

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+# Specify your gem's dependencies in u2fhost.gemspec
+gemspec

data/Gemfile.lock ADDED

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    u2fhost (1.0.0)
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bump (0.10.0)
+    diff-lcs (1.4.4)
+    fuubar (2.5.0)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-progressbar (1.10.1)
+    rufo (0.12.0)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bump
+  bundler
+  fuubar
+  rake
+  rake-compiler
+  rspec
+  rspec_junit_formatter
+  rufo
+  u2fhost!
+BUNDLED WITH
+   2.1.4

data/LICENSE ADDED

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright 2018 Xaptum, Inc
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile ADDED

@@ -0,0 +1,44 @@
+.PHONY: bundle bump-patch bump-minor bump-major deploy test
+build: compile
+	bundle exec rake build
+compile:
+	bundle exec rake compile
+console:
+	./bin/console
+bundle:
+	bundle install --jobs=4 --retry=3
+bump-patch:
+	@bundle exec rake bump:patch TAG=false BUNDLE=false COMMIT=false
+bump-minor:
+	@bundle exec rake bump:minor TAG=false BUNDLE=false COMMIT=false
+bump-major:
+	@bundle exec rake bump:major TAG=false BUNDLE=false COMMIT=false
+bump-pre:
+	@bundle exec rake bump:pre TAG=false BUNDLE=false COMMIT=false
+version:
+	@bundle exec rake bump:current TAG=false BUNDLE=false COMMIT=false
+#test:
+#	bundle exec rspec --format Fuubar --color spec/**/*_spec.rb
+install: build
+	sudo ./install.sh
+format:
+	./format.sh
+check-format:
+	@rufo --check lib
+	@rufo --check spec
+clean:
+	rm -rf pkg

data/README.md ADDED

@@ -0,0 +1,163 @@
+## u2f-host-ruby
+Ruby bindings for [libu2f-host](https://github.com/Yubico/libu2f-host) library. The `u2fhost` gem exposes two API's
+- `register` Register using a U2F device
+- `sign`     Sign using a U2F device
+This is similar to the API exposed by `u2f-api.js` javascript library.
+## Dependencies
+Before installing this gem please install `libu2f-host` for you platform.
+### macos
+```bash
+$ brew install libu2f-host
+```
+If `Homebrew` throws any error stating unable to link some library, it may be necessary to explictly call
+```bash
+$ brew link <libray name>
+```
+Sometimes it may be necessary to change the ownership of `/usr/local/{lib,share,bin}` for the above commands to work.
+```bash
+sudo chown -R `whoami`:admin /usr/local/bin
+$ sudo chown -R `whoami`:admin /usr/local/lib
+$ sudo chown -R `whoami`:admin /usr/local/share
+```
+### debian/ubuntu
+```bash
+$ apt-get update
+$ apt-get install libu2f-host-dev
+```
+### windows/other OS
+Build from source following instructions in [libu2f-host](https://github.com/Yubico/libu2f-host) repository.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'u2fhost'
+```
+And then execute:
+    $ bundle install
+Or install it yourself as:
+    $ gem install u2fhost
+## Usage
+Require the gem in your code
+```ruby
+require 'u2fhost'
+```
+### Register
+```ruby
+challenge = "..." ## challenge from server
+origin = "..." ## U2F origin URL
+response = U2fhost::register(challenge, origin)
+## send response to server to complete registration
+```
+### Sign
+```ruby
+challenge = "..." ## challenge from server
+origin = "..." ## U2F origin URL
+response = U2fhost::sign(challenge, origin)
+## send response to server to verify signature
+```
+The API's throw `U2fhost::ERROR` exception in case of any errors.
+## Development
+- Ensure `bundler` gem is installed. If not, install using
+  ```
+  $ gem install bundler
+  ```
+- Clone the repository
+- Install dependent gems
+  ```
+  $ cd u2f-host-ruby
+  $ make bundle
+  ```
+- Create a new branch
+  ```bash
+  git checkout -b <GIT_USER_NAME>/<BRANCH_NAME>
+  ```
+- Bump the version
+  ```bash
+  make bump-pre
+  ```
+- Ensure code is formatted using `rufo`. The build process will fail if the code is not formatted.
+  ```bash
+  make format
+  ```
+**NOTE: Do not fork the repository**
+## Testing
+As this gem interacts with a hardware device, any changes has to be tested manually. The project is setup to build and install the gem on the local machine.
+- build the gem
+  ```bash
+  $ make build
+  ```
+This will create the `u2fhost-VERSION.gem` file in `pkg` directory
+- install gem
+  ```bash
+  $ make install
+  ```
+This will install the gem on the local machine
+- run the test executable
+  ```bash
+  $ bin/test
+  ```
+Another way to test after installing the gem is to launch `irb`
+  ```bash
+  $ irb
+  irb(main):001:0> require 'u2fhost'
+  => true
+  irb(main):002:0>
+  ```
+## Release
+`u2fhost` pre-release and release versions are automatically published to [RubyGems](https://rubygems.org) by the build process. Each commit to `master` branch publishes a pre-release version of the gem.
+### Publishing Pre-Release version
+- Open a pull request to merge the feature branch into `master`
+- After review and approval merge feature branch into `master`
+- The build process publishes a pre-release version if gem version matches one of the following patterns:
+  - `MAJOR.MINOR.PATCH-alpha`
+  - `MAJOR.MINOR.PATCH-beta`
+  - `MAJOR.MINOR.PATCH-rc`
+### Publishing a Release version
+- Update `u2fhost` version to `MAJOR.MINOR.PATCH` in `lib/u2fhost/version.rb` and commit the change to `master`
+- Create and push a tag with the same name as the version
+- The build process publishes a release version of the gem
+# License
+Copyright 2020 Xaptum, Inc.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this work except in compliance with the License. You may obtain a copy of
+the License from the LICENSE.txt file or at
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations under
+the License.

data/Rakefile ADDED

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "bump/tasks"
+#require "rspec/core/rake_task"
+require "rake/extensiontask"
+#desc "Run tests"
+#RSpec::Core::RakeTask.new(:spec) do |t|
+#  t.pattern = "spec/**/*_spec.rb"
+#  t.verbose = true
+#end
+Rake::ExtensionTask.new("u2fhost") do |ext|
+  ext.lib_dir = "lib/u2fhost"
+end
+#gemspec = Gem::Specification.load("u2fhost.gemspec")
+#Rake::ExtensionTask.new do |ext|
+#  ext.name = "u2fhost"
+#  ext.source_pattern = "*.{c,h}"
+#  ext.ext_dir = "ext/u2fhost"
+#  ext.lib_dir = "lib/u2fhost"
+#  ext.gem_spec = gemspec
+#end
+#task :default => [:compile, :spec]
+#task :default => [:spec]

data/ext/u2fhost/extconf.rb ADDED

@@ -0,0 +1,32 @@
+#
+# Copyright 2020 Xaptum,Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require "mkmf"
+$LOCAL_LIBS << " -lu2f-host "
+$INCFLAGS << " -I/usr/local/include/u2f-host -I/usr/include/u2f-host -I /opt/local/include/u2f-host "
+#if RUBY_PLATFORM =~ /darwin/
+#  $LDFLAGS << "-framework AppKit"
+#end
+abort "missing u2fh_register2()" unless have_func "u2fh_register2"
+abort "missing u2fh_authenticate2()" unless have_func "u2fh_authenticate2"
+extension_name = "u2fhost"
+dir_config(extension_name)
+create_header
+create_makefile(extension_name)

data/ext/u2fhost/u2fhost.c ADDED

@@ -0,0 +1,146 @@
+/*
+* Copyright 2020 Xaptum,Inc
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+#include <ruby.h>
+#include <math.h>
+#include <u2f-host.h>
+#define SYM_ERROR ID2SYM(rb_intern("error"))
+#define SYM_RESPONSE ID2SYM(rb_intern("response"))
+#define BUFFER_SIZE 8192
+#define REGISTER 1
+#define SIGN 2
+// API function headers
+static VALUE ext_register(VALUE self, VALUE rb_challenge, VALUE rb_origin);
+static VALUE ext_sign(VALUE self, VALUE rb_challenge, VALUE rb_origin);
+// helper functions
+static VALUE make_hash(VALUE key, const char *value) {
+  VALUE hash = rb_hash_new();
+  rb_hash_aset(hash, key, rb_str_new2(value));
+  return hash;
+}
+static VALUE error_hash(const char *error) {
+  return make_hash(SYM_ERROR, error);
+}
+static VALUE response_hash(const char *resp) {
+  return make_hash(SYM_RESPONSE, resp);
+}
+// actual implementations
+static VALUE do_u2f_action(VALUE self, VALUE rb_challenge, VALUE rb_origin, int action) {
+  VALUE retHash = Qnil;
+  char buffer[BUFFER_SIZE] = {0};
+  u2fh_devs *devs = NULL;
+  u2fh_rc rc;
+  char *challenge = NULL;
+  char *origin = NULL;
+  char response[BUFFER_SIZE] = {0};
+  size_t response_len = sizeof(response);
+  // validate args are in string type
+  Check_Type(rb_challenge, T_STRING);
+  Check_Type(rb_origin, T_STRING);
+  // convert ruby string to C string
+  challenge = StringValueCStr(rb_challenge);
+  origin = StringValueCStr(rb_origin);
+  // initialize u2f library
+  rc = u2fh_global_init(0);
+  if( U2FH_OK != rc ) {
+    sprintf(buffer, "error: u2fh_global_init (%d): %s\n", rc, u2fh_strerror (rc));
+    return error_hash(buffer);
+  }
+  // initialize u2f devices data structure
+  rc = u2fh_devs_init(&devs);
+  if (U2FH_OK != rc) {
+    sprintf(buffer, "error: u2fh_devs_init (%d): %s\n", rc, u2fh_strerror (rc));
+    retHash = error_hash(buffer);
+    goto cleanup;
+  }
+  // discover u2f devices
+  rc = u2fh_devs_discover(devs, NULL);
+  if (U2FH_OK != rc) {
+    sprintf(buffer, "error: u2fh_devs_discover (%d): %s\n", rc, u2fh_strerror (rc));
+    retHash = error_hash(buffer);
+    goto cleanup;
+  }
+  // register/sign
+  switch(action) {
+  case REGISTER:
+    rc = u2fh_register2(devs, challenge, origin,
+			response, &response_len,
+			U2FH_REQUEST_USER_PRESENCE);
+    break;
+  case SIGN:
+    rc = u2fh_authenticate2(devs, challenge, origin,
+			    response, &response_len,
+			    U2FH_REQUEST_USER_PRESENCE);
+    break;
+  }
+  // handle response
+  if (U2FH_OK != rc) {
+    sprintf(buffer, "error (%d): %s\n", rc, u2fh_strerror (rc));
+    retHash = error_hash(buffer);
+    goto cleanup;
+  }
+  // create response hash
+  retHash = response_hash(response);
+ cleanup:
+  u2fh_devs_done(devs);
+  u2fh_global_done();
+  // return appropriate hash
+  return retHash;
+}
+// register
+static VALUE ext_register(VALUE self, VALUE rb_challenge, VALUE rb_origin) {
+  return do_u2f_action(self, rb_challenge, rb_origin, REGISTER);
+}
+// sign
+static VALUE ext_sign(VALUE self, VALUE rb_challenge, VALUE rb_origin) {
+  return do_u2f_action(self, rb_challenge, rb_origin, SIGN);
+}
+// init
+void Init_u2fhost() {
+  // create module
+  VALUE mod = rb_define_module("U2fhost");
+  // attach ext_register to the module
+  rb_define_singleton_method(mod, "ext_register", ext_register, 2);
+  // attach ext_sign to the module
+  rb_define_singleton_method(mod, "ext_sign", ext_sign, 2);
+}

data/format.sh ADDED

@@ -0,0 +1,9 @@
+#!/bin/bash
+## Formatting is done using rufo library
+## rufo exits with exit code 3 if it is able to
+## format the code.
+echo "Formatting code.."
+rufo lib spec
+echo "Formatted!"

data/install.sh ADDED

@@ -0,0 +1,10 @@
+#!/bin/bash
+echo "Installing u2fhost gem locally"
+version=$(make version)
+## Uninstall gem if necessary
+gem uninstall u2fhost
+## install gem
+gem install pkg/u2fhost-$version.gem

data/lib/u2fhost.rb ADDED

@@ -0,0 +1,49 @@
+#
+# Copyright 2020 Xaptum,Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require "u2fhost/version"
+require "u2fhost.so"
+module U2fhost
+  class ERROR < StandardError
+    def initialize(msg = "ENF Api Error")
+      super
+    end
+  end
+  ## register API
+  def self.register(challenge, origin)
+    ## call extenstion
+    call_ext_block { ext_register(challenge, origin) }
+  end
+  ## sign API
+  def self.sign(challenge, origin)
+    ## call extenstion
+    call_ext_block { ext_sign(challenge, origin) }
+  end
+  def self.call_ext_block
+    ## call extenstion
+    hash = yield
+    ## parse return value from the calling extenstion
+    ## raise exception if error response
+    raise U2fhost::ERROR, hash[:error] if hash[:error]
+    ## return response
+    hash[:response]
+  end
+end

data/lib/u2fhost/version.rb ADDED

@@ -0,0 +1,18 @@
+#
+# Copyright 2020 Xaptum,Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module U2fhost
+  VERSION = "1.0.0"
+end

data/u2fhost.gemspec ADDED

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "u2fhost/version"
+Gem::Specification.new do |spec|
+  spec.name = "u2fhost"
+  spec.version = U2fhost::VERSION
+  spec.authors = ["Venkatakumar Srinivasan", "Matthew Lee"]
+  spec.email = ["venkat@xaptum.com", "matthew.lee@xaptum.com"]
+  spec.summary = %q{Ruby bindings for libu2f-host}
+  spec.homepage = "https://www.xaptum.com"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/xaptum/u2fhost"
+  # 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(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.extensions << "ext/u2fhost/extconf.rb"
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bump"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "rufo"
+end

metadata ADDED

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: u2fhost
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Venkatakumar Srinivasan
+- Matthew Lee
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: bundler
+  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: rake
+  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: bump
+  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: rspec
+  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: rspec_junit_formatter
+  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: fuubar
+  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: rufo
+  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:
+email:
+- venkat@xaptum.com
+- matthew.lee@xaptum.com
+executables: []
+extensions:
+- ext/u2fhost/extconf.rb
+extra_rdoc_files: []
+files:
+- ".circleci/Dockerfile"
+- ".circleci/build.sh"
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- ext/u2fhost/extconf.rb
+- ext/u2fhost/u2fhost.c
+- format.sh
+- install.sh
+- lib/u2fhost.rb
+- lib/u2fhost/version.rb
+- u2fhost.gemspec
+homepage: https://www.xaptum.com
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://www.xaptum.com
+  source_code_uri: https://github.com/xaptum/u2fhost
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Ruby bindings for libu2f-host
+test_files: []