enmail 0.1.0 → 0.2.0

data/README.md

@@ -1,115 +0,0 @@
-# EnMail
-
-[![Build
-Status](https://travis-ci.org/riboseinc/enmail.svg?branch=master)](https://travis-ci.org/riboseinc/enmail)
-
-EnMail (Encrypted mail) helps the Ruby mail gem send secure encrypted messages.
-
-The two ways for secure mail are:
-* OpenPGP
-* S/MIME
-
-This gem allows you to select different OpenPGP implementations
-including NetPGP and GnuPG as different OpenPGP adapters, and also
-S/MIME.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "enmail"
-```
-
-And then execute:
-
-```sh
-bundle install
-```
-
-Or install it yourself as:
-
-```sh
-gem install enmail
-```
-
-## Configure
-
-The `EnMail` gem provides a very easier interface to set custom configurations
-or configure the underlying dependencies, we can configure it by adding an
-initializer with the following code
-
-```ruby
-EnMail.configure do |config|
-  config.sign_message = true
-  config.smime_adapter = :openssl
-  config.secret_key = "Secret Key String"
-
-  config.certificates_path = "CERTIFICATES_ROOT_PAH"
-end
-```
-
-Or
-
-```ruby
-EnMail.configuration.certificates_path = "CERTIFICATES_ROOT_PAH"
-```
-
-## Usage
-
-```sh
-bin/console
-```
-
-## Development
-
-We are following Sandi Metz's Rules for this gem, you can read the
-[description of the rules here][sandimetz]. All new code should follow these
-rules. If you make changes in a pre-existing file that violates these rules you
-should fix the violations as part of your contribution.
-
-### Setup
-
-Clone the repository.
-
-```sh
-git clone https://github.com/riboseinc/enmail
-```
-
-Setup your environment.
-
-```sh
-bin/setup
-```
-
-Run the test suite
-
-```sh
-bin/rspec
-```
-
-## Contributing
-
-First, thank you for contributing! We love pull requests from everyone. By
-participating in this project, you hereby grant [Ribose Inc.][ribose] the
-right to grant or transfer an unlimited number of non exclusive licenses or
-sub-licenses to third parties, under the copyright covering the contribution
-to use the contribution by all means.
-
-Here are a few technical guidelines to follow:
-
-1. Open an [issue][issues] to discuss a new feature.
-1. Write tests to support your new feature.
-1. Make sure the entire test suite passes locally and on CI.
-1. Open a Pull Request.
-1. [Squash your commits][squash] after receiving feedback.
-1. Party!
-
-## Credits
-
-This gem is developed, maintained and funded by [Ribose Inc.][ribose]
-
-[ribose]: https://www.ribose.com
-[issues]: https://github.com/abunashir/enmail/issues
-[squash]: https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature
-[sandimetz]: http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers

data/lib/enmail/certificate_finder.rb

@@ -1,75 +0,0 @@
-require "openssl"
-
-module EnMail
-  class CertificateFinder
-    def initialize(email:)
-      @email = email
-    end
-
-    # Certificate
-    #
-    # This returns an `OpenSSL::X509::Certificate` instnace which
-    # usages the content for the pem certificate. The certificate
-    # name is the dotify version of the email with `pem` ext.
-    #
-    def certificate
-      certificate_instance
-    end
-
-    # Private Key
-    #
-    # This returns an `OpenSSL::PKey::RSA` instnace which usages
-    # the content for keyfile. The keyfile is the dotify version
-    # of the email with `key` ext.
-    #
-    def private_key
-      private_key_instance
-    end
-
-    # Self.find_by_email
-    #
-    # Initialize a new instnace with more readble interface.
-    #
-    def self.find_by_email(email)
-      new(email: email)
-    end
-
-    private
-
-    attr_reader :email
-
-    def certificate_instance
-      OpenSSL::X509::Certificate.new(
-        certificate_file(extension: :pem),
-      )
-    end
-
-    def private_key_instance
-      OpenSSL::PKey::RSA.new(
-        certificate_file(extension: :key),
-      )
-    end
-
-    def certificate_file(extension:)
-      content_for(
-        [dotify_email, extension.to_s].join("."),
-      )
-    end
-
-    def dotify_email
-      @dotify_email ||= email.sub("@", ".")
-    end
-
-    def content_for(filename)
-      File.read(certificate_file_with_path(filename))
-    end
-
-    def certificate_file_with_path(certificate)
-      File.join(certificates_root, certificate)
-    end
-
-    def certificates_root
-      EnMail.configuration.certificates_path
-    end
-  end
-end

data/lib/enmail/config.rb

@@ -1,21 +0,0 @@
-require "enmail/configuration"
-
-module EnMail
-  module Config
-    def configure
-      if block_given?
-        yield configuration
-      end
-    end
-
-    def configuration
-      @configuration ||= EnMail::Configuration.new
-    end
-  end
-
-  # Expose config module methods as class level method, so we can
-  # use those method whenever necessary. Specially `configuration`
-  # throughout the gem
-  #
-  extend Config
-end

data/lib/enmail/configuration.rb

@@ -1,80 +0,0 @@
-module EnMail
-  class Configuration
-    attr_reader :smime_adapter
-    attr_accessor :sign_message, :certificates_path
-    attr_accessor :sign_key, :encrypt_key
-
-    def initialize
-      @sign_message = true
-      @smime_adapter = :openssl
-    end
-
-    # Signable?
-    #
-    # Returns the message signing status, by defualt it will return `true`.
-    # If the user provided a custom configuration for `sign_message` then
-    # it will use that status, so we can easily skip it when desirable.
-    #
-    def signable?
-      sign_message == true
-    end
-
-    # Set smime adapter
-    #
-    # This allows us to set a valid smime adapter, once this has been
-    # set then the gem will use this on to select the correct adapter
-    # class and then use that one to to `sign` a message.
-    #
-    # @param adapter adapter you want to use to sign the message
-    #
-    def smime_adapter=(adapter)
-      if valid_smime_adapter?(adapter)
-        @smime_adapter = adapter
-      end
-    end
-
-    # Adapter klass name
-    #
-    # This returns the string class name for the configured smime
-    # adapter. We are lazely loading the adapter so this interface
-    # will return the string verion.  Please do not forget to use
-    # `Object.const_get` before invokng any method on it.
-    #
-    def smime_adapter_klass
-      smime_adapter_symbol_to_klass
-    end
-
-    # Default key
-    #
-    # This returns a Key instance with the configured keys.
-    # @return [EnMail::Key] the configured default key attributes.
-    #
-    def defualt_key
-      EnMail::Key.new(sign_key: sign_key, encrypt_key: encrypt_key)
-    end
-
-    private
-
-    def valid_smime_adapter?(adapter)
-      smime_adapters.include?(adapter.to_sym)
-    end
-
-    def smime_adapter_symbol_to_klass
-      adapter_klasses.fetch(smime_adapter.to_sym)
-    end
-
-    # Supported smime adapters
-    #
-    # The list of the supported smime adapters, if we add support for
-    # a new smime adapter then please update this list and this way we
-    # can ensure user can configure the gem with supported adapter only
-    #
-    def smime_adapters
-      [:openssl].freeze
-    end
-
-    def adapter_klasses
-      { openssl: "EnMail::Adapters::OpenSSL" }
-    end
-  end
-end

data/lib/enmail/enmailable.rb

@@ -1,43 +0,0 @@
-module EnMail
-  module EnMailable
-    # Sign a message
-    #
-    # This interface allow us to sign a message while using this gem, this
-    # also forecefully sets the `signable` status true, so it ensures that
-    # the specific message will be signed before sending out.
-    #
-    # @param passphrase [String] the passphrase for the sign key
-    # @param key [EnMail::Key] the key model instance
-    #
-    def sign(passphrase: "", key: nil)
-      @key = key
-
-      unless passphrase.empty?
-        signing_key.passphrase = passphrase
-      end
-    end
-
-    # Signing key
-    #
-    # This returns the signing key when applicable, the default signing
-    # key is configured through an initializer, but we are also allowing
-    # user to provide a custom key when they are invoking an interface.
-    #
-    # @return [EnMail::Key] the key model instance
-    #
-    def signing_key
-      @key || EnMail.configuration.defualt_key
-    end
-
-    # Signing status
-    #
-    # This returns the message signing status based on the user specified
-    # configuration and signing key. If the user enabled sign_message and
-    # provided a valid signing key then this will return true otherwise
-    # false, this can be used before trying to sing a message.
-    #
-    def signable?
-      signing_key.sign_key && EnMail.configuration.signable?
-    end
-  end
-end

data/lib/enmail/key.rb

@@ -1,53 +0,0 @@
-module EnMail
-  class Key
-    # @!attribute [r] sign_key
-    #   @return [String] the signing key content
-    #
-    attr_reader :sign_key
-
-    # @!attribute passphrase
-    #   @return [String] the signing key passphrase
-    #
-    attr_reader :passphrase
-
-    # @!attribute [r] encrypt_key
-    #   @return [String] the encryping key content
-    #
-    attr_reader :encrypt_key
-
-    # @!attribute [r] certificate
-    #   @return [String] the certificate content
-    #
-    attr_reader :certificate
-
-    # Initialize a key model with the basic attributes, this expects us
-    # to provided the key/certificate as string and when we actually use
-    # it then the configured adapter will use it as necessary.
-    #
-    # @param :sign_key [String] the signing key content
-    # @param :passphrase [String] the passphrase for encrypted key
-    # @param :encrypt_key [String] the encryping key content
-    # @param :certificate [String] the signing certificate content
-    #
-    # @return [EnMail::Key] - the EnMail::Key model
-    #
-    def initialize(attributes)
-      @sign_key = attributes.fetch(:sign_key, "")
-      @passphrase = attributes.fetch(:passphrase, "")
-      @encrypt_key = attributes.fetch(:encrypt_key, "")
-      @certificate = attributes.fetch(:certificate, "")
-    end
-
-    # Set the passphrase value
-    #
-    # This allow us to set the passphrase after initialization, so if the
-    # user prefere then they can pass the passphrase during the siging /
-    # encrypting steps and we can set that one when necessary
-    #
-    # @param passphrase [String] the passphrase for encrypted key
-    #
-    def passphrase=(passphrase)
-      @passphrase = passphrase
-    end
-  end
-end

data/lib/enmail/mail_ext/message.rb

@@ -1,18 +0,0 @@
-require "mail"
-require "enmail/enmailable"
-
-module Mail
-  class Message
-    # Include enmail interfaces
-    #
-    # We are supporting some custom interfaces for the mail instance,
-    # so the user can use `sign`, `encrypt` and `decrypt` directly to
-    # their mail instance.
-    #
-    # The `EnMail::EnMailable` module defines all of the interfaces
-    # to support the above funcitonality, so let's include that and
-    # please check `EnMail::EnMailable` for more details on those.
-    #
-    include EnMail::EnMailable
-  end
-end

data/lib/mail/secure/mail_interceptors/pgp.rb

@@ -1,53 +0,0 @@
-module MailInterceptors
-  class PGP
-
-    def self.delivering_email(mail)
-
-      return unless mail.gpg
-
-      options = TrueClass === mail.gpg ? { encrypt: true } : mail.gpg
-      # encrypt and sign are off -> do not encrypt or sign
-      if options.delete(:encrypt)
-        receivers = []
-        receivers += mail.to if mail.to
-        receivers += mail.cc if mail.cc
-        receivers += mail.bcc if mail.bcc
-
-        if options[:sign_as]
-          options[:sign] = true
-          options[:signers] = options.delete(:sign_as)
-        elsif options[:sign]
-          options[:signers] = mail.from
-        end
-
-        # Need to remove any non-SignedPart & non-SignPart
-        mail.body = ''
-
-        mail.add_part Mail::Gpg::VersionPart.new
-        mail.add_part Mail::Gpg::EncryptedPart.new(mail, options.merge({recipients: receivers}))
-        mail.content_type "multipart/encrypted; protocol=\"application/pgp-encrypted\"; boundary=#{mail.boundary}"
-        mail.body.preamble = options[:preamble] || "This is an OpenPGP/MIME encrypted message (RFC 2440 and 3156)"
-
-      elsif options[:sign] || options[:sign_as]
-
-        to_be_signed = Mail::Gpg::SignedPart.build(mail)
-
-        # Need to remove any non-SignedPart & non-SignPart
-        mail.body = ''
-
-        mail.add_part to_be_signed
-        mail.add_part to_be_signed.sign(options)
-
-        mail.content_type "multipart/signed; micalg=pgp-sha1; protocol=\"application/pgp-signature\"; boundary=#{mail.boundary}"
-        mail.body.preamble = options[:preamble] || "This is an OpenPGP/MIME signed message (RFC 4880 and 3156)"
-      end
-
-      puts "pee pee mail@"
-      pp mail
-
-    rescue Exception
-      raise $! if mail.raise_encryption_errors
-    end
-
-  end
-end