rnp 0.2.0 → 1.0.0

data/lib/rnp/utils.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# (c) 2018 Ribose Inc.
+
+require 'ffi'
+
+require 'rnp/error'
+require 'rnp/ffi/librnp'
+
+class Rnp
+  # @api private
+  #
+  # Calls the LibRnp FFI function indicated.
+  # If the return code is <0, an error will be raised.
+  #
+  # @param fn [Symbol] the name of the function to call
+  # @param args the arguments to pass to the FFI function
+  # @return [void]
+  def self.call_ffi(fn, *args)
+    rc = LibRnp.method(fn).call(*args)
+    Rnp.raise_error("#{fn} failed", rc) unless rc.zero?
+    nil
+  end
+
+  # @api private
+  def self.inspect_ptr(myself)
+    ptr_format = "0x%0#{FFI::Pointer.size * 2}x"
+    ptr_s = format(ptr_format, myself.instance_variable_get(:@ptr).address)
+    class_name = myself.class.to_s
+    "#<#{class_name}:#{ptr_s}>"
+  end
+
+  unless FFI::MemoryPointer.respond_to?(:from_data)
+    # @api private
+    class << FFI::MemoryPointer
+      def from_data(data)
+        buf = FFI::MemoryPointer.new(:uint8, data.bytesize)
+        buf.write_bytes(data)
+        buf
+      end
+    end
+  end
+end # class
+

data/lib/rnp/version.rb

@@ -1,3 +1,8 @@
-module Rnp
-  VERSION = "0.2.0"
-end
+# frozen_string_literal: true
+
+# (c) 2018 Ribose Inc.
+
+class Rnp
+  VERSION = '1.0.0'
+end # class
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rnp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,61 +94,93 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 description: Support rnp's OpenPGP functionality via ruby-ffi. Requires librnp.so.
 email:
 - open.source@ribose.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.adoc
+- CHANGELOG.adoc
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.adoc
+- LICENSE.txt
 - README.adoc
-- Rakefile
-- Use_Cases.adoc
-- bin/console
-- bin/setup
-- example-usage.rb
-- examples/highlevel/decrypt_mem.rb
-- examples/highlevel/encrypt_mem.rb
-- examples/lowlevel/decrypt_file.rb
-- examples/lowlevel/decrypt_mem.rb
-- examples/lowlevel/encrypt_file.rb
-- examples/lowlevel/encrypt_mem.rb
-- examples/lowlevel/load_pubkey.rb
-- examples/lowlevel/print_keyring_file.rb
-- examples/lowlevel/print_keyring_mem.rb
-- examples/lowlevel/sign_file.rb
-- examples/lowlevel/sign_mem.rb
-- examples/lowlevel/verify_file.rb
-- examples/lowlevel/verify_mem.rb
 - lib/rnp.rb
-- lib/rnp/highlevel.rb
-- lib/rnp/highlevel/constants.rb
-- lib/rnp/highlevel/keyring.rb
-- lib/rnp/highlevel/publickey.rb
-- lib/rnp/highlevel/secretkey.rb
-- lib/rnp/highlevel/utils.rb
-- lib/rnp/lowlevel.rb
-- lib/rnp/lowlevel/constants.rb
-- lib/rnp/lowlevel/dynarray.rb
-- lib/rnp/lowlevel/enums.rb
-- lib/rnp/lowlevel/libc.rb
-- lib/rnp/lowlevel/libopenssl.rb
-- lib/rnp/lowlevel/librnp.rb
-- lib/rnp/lowlevel/structs.rb
-- lib/rnp/lowlevel/utils.rb
+- lib/rnp/error.rb
+- lib/rnp/ffi/librnp.rb
+- lib/rnp/input.rb
+- lib/rnp/key.rb
+- lib/rnp/misc.rb
+- lib/rnp/op/encrypt.rb
+- lib/rnp/op/sign.rb
+- lib/rnp/op/verify.rb
+- lib/rnp/output.rb
+- lib/rnp/rnp.rb
+- lib/rnp/utils.rb
 - lib/rnp/version.rb
-- rnp.gemspec
-- rnp/lib/rnp.rb
-- rnp/spec/rnp_spec.rb
 homepage: https://www.ribose.com
-licenses: []
-metadata: {}
+licenses:
+- MIT
+metadata:
+  yard.run: yard
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -115,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -123,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the rnp OpenPGP library

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at ronald.tse@ribose.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/Use_Cases.adoc

@@ -1,119 +0,0 @@
-= Use Cases
-
-1. Generate or import a secret key, and read its properties:
-
-[source,ruby]
-----
-key = Rnp::SecretKey.new
-key.generate(
-  key_length: Integer,
-  public_key_algorithm: PublicKeyAlgorithm::RSA,
-  algorithm_params: { e: Integer }, # content is public_key_algorithm specific
-  userid: String || Userid,
-  hash_algorithm: HashAlgorithm,
-  symmetric_key_algorithm: SymmetricKeyAlgorithm
-)
-
-key.version # must be 4
-key.userids # => [] with its User ID packets
-key.userid_signatures # => [] of Signature Packets of its User ID packets
-key.passphrase # sets the passphrase if non-blank
-key.key_id # => key id of key
-key.fingerprint # => fingerprint of key
-key.key_length # length of key
-----
-
-
-2. (Generate and) Add a Subkey to a secret key:
-
-[source,ruby]
-----
-subkey = SecretSubkeyPacketV4.new
-subkey.generate(
-  key_length: Integer,
-  public_key_algorithm: PublicKeyAlgorithm,
-  algorithm_params: { e: Integer }, # content is public_key_algorithm specific
-  userid: String || Userid,
-  hash_algorithm: HashAlgorithm,
-  symmetric_key_algorithm: SymmetricKeyAlgorithm
-)
-
-# Adds subkey to key
-key.add_subkey(subkey)
-
-# Or
-subkey_self_sig = Signature.new
-subkey_self_sig.type = SignatureType::SubkeyBinding
-subkey_self_sig.userid = userid
-subkey_self_sig.key_flags = [:encrypt_data, :encrypt_comm, :cert]
-subkey_self_sig.key_expiration_time = DateTime
-subkey_self_sig.creation_time = DateTime
-
-----
-
-3. Sign and verify a PGP message
-
-[source,ruby]
-----
-# Plaintext OpenPGP message
-plaintext_data = File.read("plaintext.txt")
-# automatically creates a LiteralDataPacket inside
-literal_message = LiteralMessage.new(plaintext_data)
-
-# Signed OpenPGP message
-message = SignedMessage.new(literal_message)
-message.content = literal_message # alternative to above
-message.key = SecretKey
-message.sign # => SignedMessage [SignaturePacket, LiteralMessage]
-
-# Or
-message = OnePassSignedMessage.new(
-  signature_type: PositiveCertification,
-  hash_algorithm: HashAlgorithm,
-  public_key_algorithm: PublicKeyAlgorithm,
-  key: SecretKey || PublicKey,
-  content: literal_message
-) # => OnePassSignedMessage is an OpenPgpMessage
-
-message.to_s # ASCII armored message
-
-# Verifying a PGP message
-public_key.verify(message.signature, message.content)
-secret_key.verify(message.signature, message.content)
-----
-
-4. Encrypt and decrypt a PGP message
-
-[source,ruby]
-----
-# Encrypted OpenPGP message
-message = EncryptedMessage.new
-message.key = YourPublicKey
-message.public_key_algorithm = PublicKeyAlgorithm
-message.content = plaintext_data
-
-# Decrypt OpenPGP message
-message = Rnp::OpenPgpMessage.new
-
-# Importing from ASCII armored PGP message
-message.import_ascii(File.read("ascii_armored_pgp_message.txt"))
-
-# Importing unarmored content
-message.import_raw(File.read("base64_portion_of_multipart_email.eml"))
-
-message.signature # => signature of message in Rnp::Signature
-message.signer_userid # => signer in Rnp::Userid
-message.signed? # => is message signed?
-message.encrypted? # => is message encrypted?
-message.decrypt(key) # => decrypt content of message
-message.content # => decrypted content of message
-----
-
-5. Packet and Keychain functionalities.
-
-While these are not crucial, the Packet stuff will aid a higher level
-implementation.
-
-The `rnp_*` functions do support signing / verifying / encrypting /
-decrypting, but for generate key (Case 1) especially for subkeys we need
-to implement the remaining stuff in Ruby.