enfcli 4.0.0 → 5.0.0.pre.alpha

data/lib/enfcli/commands/xiam.rb

@@ -13,18 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'enfthor'
-require 'enfapi'
-require 'digest'
-require 'openssl'
-require 'ipaddr'
+require "enfthor"
+require "enfapi"
+require "digest"
+require "openssl"
+require "ipaddr"
 
 module EnfCli
   module Cmd
-
     class Xiam < EnfThor
       no_commands {
-        def write_pem_file keyfile, data
+        def write_pem_file(keyfile, data)
           # check if keyfile ends with .pem extension
           keyfile = "#{keyfile}.pem" unless keyfile.end_with?(".pem")
 
@@ -34,17 +33,17 @@ module EnfCli
           end
         end
 
-        def write_to_file filename, data
+        def write_to_file(filename, data)
           begin
             # check if file exists
             filename = EnfCli::expand_path(filename)
-            if File.exists?( filename )
+            if File.exists?(filename)
               proceed = ask("Overwrite #{filename}(type 'yes' to continue...)?")
-              return nil unless (proceed.downcase == 'yes')
+              return nil unless (proceed.downcase == "yes")
             end
 
             # write to file
-            open filename, 'w' do |io| io.write data end
+            open filename, "w" do |io| io.write data end
 
             # return success
             return true
@@ -59,13 +58,13 @@ module EnfCli
 
         def scan_group_qr_code()
           # Initalize values
-          gpk_header = ''
-          gpk_info = ''
+          gpk_header = ""
+          gpk_info = ""
 
           # Scan QR Code
-          gpk_header = EnfCli::ask_password('Scan DAA group information:')
+          gpk_header = EnfCli::ask_password("Scan DAA group information:")
           if gpk_header.length < 16
-            gpk_info = EnfCli::ask_password('')
+            gpk_info = EnfCli::ask_password("")
           else
             tmp_header = gpk_header[0..12]
             gpk_info = gpk_header[13..gpk_header.length]
@@ -90,7 +89,7 @@ module EnfCli
         def read_ec_key_file(keyfile)
           # expand path
           keyfile = EnfCli::expand_path(keyfile)
-          
+
           ## return if keyfile not found
           raise EnfCli::ERROR, "#{keyfile} not found!" unless File.exists?(keyfile)
 
@@ -98,16 +97,15 @@ module EnfCli
           OpenSSL::PKey::EC.new(File.read(keyfile))
         end
 
-        def display_groups groups
-          headings = ['DAA Group', 'Base Name', 'Provisioned', 'Onboarded', 'Default Network', 'Domain' ]
-          rows = groups.map{ |hash|
-            [ hash[:gid],
-              hash[:basename],
-              hash[:provisioned_count],
-              hash[:onboarded_count],
-              hash[:default_network] ? hash[:default_network] : '<not set>',
-              hash[:domain],
-            ]
+        def display_groups(groups)
+          headings = ["DAA Group", "Base Name", "Provisioned", "Onboarded", "Default Network", "Domain"]
+          rows = groups.map { |hash|
+            [hash[:gid],
+             hash[:basename],
+             hash[:provisioned_count],
+             hash[:onboarded_count],
+             hash[:default_network] ? hash[:default_network] : "<not set>",
+             hash[:domain]]
           }
           render_table(headings, rows)
         end
@@ -119,23 +117,23 @@ module EnfCli
           # create NEW_CREDENTIAL_ECDSA
           new_credential = {
             :type => "ecdsa_p256",
-            :key => pubkey
-          }          
+            :key => pubkey,
+          }
 
           # create NEW_ENDPOINT_AUTH
           new_endpoint_auth = {
             :ecdsa_credential => new_credential,
             :address_request => {
-              :address => ipv6_address.to_s
-            }
+              :address => ipv6_address.to_s,
+            },
           }
 
           data = EnfApi::Iam.instance.provision_endpoint new_endpoint_auth
           provisioned_ip = data[:address]
 
           # Make sure provisioned ip is same as the requested ip
-          raise EnfCli::ERROR, "Provisioned IPv6 address not the same as requested" unless provisioned_ip.eql?( ipv6_address.to_s )
-          
+          raise EnfCli::ERROR, "Provisioned IPv6 address not the same as requested" unless provisioned_ip.eql?(ipv6_address.to_s)
+
           say "Created new ipv6 endpoint #{provisioned_ip}", :green
         end
 
@@ -146,7 +144,7 @@ module EnfCli
           # create NEW_CREDENTIAL_ECDSA
           new_credential = {
             :type => "ecdsa_p256",
-            :key => pubkey
+            :key => pubkey,
           }
 
           EnfApi::Iam.instance.update_endpoint_key ipv6_address, new_credential
@@ -155,11 +153,12 @@ module EnfCli
         end
       }
 
-      option_gid = [:gid, {default: nil, type: :string, banner: 'GID',
-                           desc: 'The group to get. If not specified, scan the group QR code'}]
+      option_gid = [:gid, { default: nil, type: :string, banner: "GID",
+                            desc: "The group to get. If not specified, scan the group QR code" }]
 
       desc "get-group", "Get DAA Group Information"
       method_option *option_gid
+
       def get_group
         try_with_rescue_in_session do
           # scan if gid not in options
@@ -178,8 +177,9 @@ module EnfCli
       end
 
       desc "list-groups", "List DAA Groups Information"
-      method_option :'network', default: nil, type: :string, banner: 'NETWORK',
-                                desc: 'List only groups in this network'
+      method_option :'network', default: nil, type: :string, banner: "NETWORK",
+                                desc: "List only groups in this network"
+
       def list_groups
         try_with_rescue_in_session do
           # The xiam API doesn't properly support the 'network' query
@@ -207,6 +207,7 @@ module EnfCli
       desc "set-group-default-network", "Set /64 network as default for the DAA group"
       method_option :'network', :type => :string, :required => true
       method_option *option_gid
+
       def set_group_default_network
         try_with_rescue_in_session do
           network = EnfCli::IPV6Cidr.new(options[:network]).to_s
@@ -221,7 +222,7 @@ module EnfCli
           # create MODIFIED_GROUP
           modified_group = {
             :gid => gid,
-            :default_network => network
+            :default_network => network,
           }
 
           # Post to server
@@ -234,6 +235,7 @@ module EnfCli
       desc "set-group-domain", "Set /48 domain for the DAA group"
       method_option :'domain', :type => :string, :required => true
       method_option *option_gid
+
       def set_group_domain
         try_with_rescue_in_session do
           domain = EnfCli::IPV6Cidr.new(options[:domain]).to_s
@@ -248,7 +250,7 @@ module EnfCli
           # create MODIFIED_GROUP
           modified_group = {
             :gid => gid,
-            :domain => domain
+            :domain => domain,
           }
 
           # Post to server
@@ -262,6 +264,7 @@ module EnfCli
       method_option :'network', :type => :string, :required => true
       method_option *option_gid
       method_option :'set_as_default', :type => :boolean, default: false, desc: "Set the network as the default for this group"
+
       def add_group_to_network
         try_with_rescue_in_session do
           network = EnfCli::IPV6Cidr.new(options[:network]).to_s
@@ -276,7 +279,7 @@ module EnfCli
           if options[:set_as_default]
             modified_group = {
               :gid => gid,
-              :default_network => network
+              :default_network => network,
             }
 
             EnfApi::Iam.instance.update_group gid, modified_group
@@ -291,6 +294,7 @@ module EnfCli
       desc "provision-group", "Provision a DAA Group"
       method_option :'device-count', :type => :numeric, :required => true
       method_option :'operator', :type => :array, :required => true, :banner => "OPERATOR"
+
       def provision_group
         try_with_rescue_in_session do
           qr_code_info = scan_group_qr_code()
@@ -311,16 +315,16 @@ module EnfCli
           new_provisioning = {
             :group_id => gid,
             :quantity => quantity,
-            :operator => operator
+            :operator => operator,
           }
 
           # create NEW_GROUP
           new_group = {
             :group_public_key => gpk,
             :basename => basename,
-            :provisionings => [ new_provisioning ]
+            :provisionings => [new_provisioning],
           }
-            
+
           # Post to server
           EnfApi::Iam.instance.provision_group new_group
 
@@ -330,16 +334,17 @@ module EnfCli
       end
 
       desc "create-endpoint-key", "Generate a pem encoded EC key pair"
-      method_option :'key-out-file', :type => :string, :required => true, :banner => '<file>'
-      method_option :'public-key-out-file', :type => :string, :required => true, :banner => '<file>'
+      method_option :'key-out-file', :type => :string, :required => true, :banner => "<file>"
+      method_option :'public-key-out-file', :type => :string, :required => true, :banner => "<file>"
+
       def create_endpoint_key
         try_with_rescue_in_session do
           # get options
-          keyfile = options['key-out-file']
-          pubfile = options['public-key-out-file']
+          keyfile = options["key-out-file"]
+          pubfile = options["public-key-out-file"]
 
           # Generate a key pair
-          key = OpenSSL::PKey::EC.new('prime256v1')
+          key = OpenSSL::PKey::EC.new("prime256v1")
           key.generate_key
 
           # write key pair to file
@@ -347,20 +352,21 @@ module EnfCli
 
           # write public key to file
           key.private_key = nil
-          write_pem_file pubfile, key.to_pem        
+          write_pem_file pubfile, key.to_pem
         end
       end
 
       desc "create-endpoint-cert", "Creates and signs a certificate for a particular identity using the provided private key"
-      method_option :'identity', :type => :string, :required => true, :banner => '<ipv6>'
-      method_option :'key-in-file', :type => :string, :required => true, :banner => '<file>'
-      method_option :'cert-out-file', :type => :string, :required => true, :banner => '<file>'
+      method_option :'identity', :type => :string, :required => true, :banner => "<ipv6>"
+      method_option :'key-in-file', :type => :string, :required => true, :banner => "<file>"
+      method_option :'cert-out-file', :type => :string, :required => true, :banner => "<file>"
+
       def create_endpoint_cert
         try_with_rescue_in_session do
           # get options
-          ipv6 = EnfCli::IPV6.new(options['identity']).to_s
-          keyfile = EnfCli::expand_path(options['key-in-file'])
-          certfile = EnfCli::expand_path(options['cert-out-file'])
+          ipv6 = EnfCli::IPV6.new(options["identity"]).to_s
+          keyfile = EnfCli::expand_path(options["key-in-file"])
+          certfile = EnfCli::expand_path(options["cert-out-file"])
 
           # read the private key
           key = read_ec_key_file keyfile
@@ -369,18 +375,19 @@ module EnfCli
           cert = EnfCli::generate_ec_cert(key, ipv6)
 
           # write to file
-          write_pem_file certfile, cert.to_pem          
+          write_pem_file certfile, cert.to_pem
         end
       end
 
       desc "create-endpoint-in-network", "Create an IPV6 endpoint in /64 network"
       method_option :'network', :type => :string, :required => true, :banner => "<ipv6 network>"
       method_option :'public-key-in-file', :type => :string, :required => true, :banner => "<file>"
+
       def create_endpoint_in_network
         try_with_rescue_in_session do
           # Read options
           network = EnfCli::IPV6Cidr.new(options[:network]).to_s
-          keyfile = EnfCli::expand_path(options['public-key-in-file'])
+          keyfile = EnfCli::expand_path(options["public-key-in-file"])
 
           # read keyfile
           key = read_ec_key_file keyfile
@@ -392,49 +399,50 @@ module EnfCli
           # create NEW_CREDENTIAL_ECDSA
           new_credential = {
             :type => "ecdsa_p256",
-            :key => pubkey
+            :key => pubkey,
           }
-          
+
           # create NEW_ENDPOINT_AUTH
           new_endpoint = {
             :ecdsa_credential => new_credential,
             :address_request => {
-              :network => network
-            }
+              :network => network,
+            },
           }
 
           data = EnfApi::Iam.instance.provision_endpoint new_endpoint
           provisioned_ip = data[:address]
-          
+
           say "Created new ipv6 endpoint #{provisioned_ip}", :green
         end
       end
 
       desc "create-endpoint-with-address", "Create an IPV6 endpoint in /64 network with user specified address"
       method_option :'address', :type => :string, :required => true, :banner => "<ipv6 address>"
-      method_option :'public-key-in-file', :type => :string, :required => true, :banner => "<file>"      
+      method_option :'public-key-in-file', :type => :string, :required => true, :banner => "<file>"
+
       def create_endpoint_with_address
         try_with_rescue_in_session do
           # Read address
           ipv6_address = EnfCli::IPV6.new options[:address]
 
           # read key
-          keyfile = EnfCli::expand_path(options['public-key-in-file'])
+          keyfile = EnfCli::expand_path(options["public-key-in-file"])
           key = read_ec_key_file keyfile
           pub = key.public_key
 
           # create_endpoint
           provision_endpoint ipv6_address, pub
-          
         end
       end
 
       desc "create-endpoint-from-cert", "Create an IPV6 endpoint in /64 network with address from cert"
-      method_option :'cert-in-file', :type => :string, :required => true, :banner => "<file>"      
+      method_option :'cert-in-file', :type => :string, :required => true, :banner => "<file>"
+
       def create_endpoint_from_cert
         try_with_rescue_in_session do
           # read options
-          certfile = EnfCli::expand_path(options['cert-in-file'])
+          certfile = EnfCli::expand_path(options["cert-in-file"])
           raise EnfCli::ERROR, "#{certfile} does not exist!" unless File.exists?(certfile)
 
           # read cert file
@@ -445,42 +453,43 @@ module EnfCli
           subject = cert.subject.to_a
 
           # get ipv6 CN record
-          cn = subject.select { |d| "CN".eql?( d[0].upcase ) }
-          ipv6_address =  EnfCli::IPV6.new cn[0][1]
+          cn = subject.select { |d| "CN".eql?(d[0].upcase) }
+          ipv6_address = EnfCli::IPV6.new cn[0][1]
 
           # get the public key
           pub = cert.public_key.public_key
 
           # create_endpoint
           provision_endpoint ipv6_address, pub
-          
-        end        
+        end
       end
 
       desc "update-endpoint-key", "Update an IPV6 endpoint's credentials"
       method_option :'address', :type => :string, :required => true, :banner => "<ipv6 address>"
       method_option :'public-key-in-file', :type => :string, :required => true, :banner => "<file>"
+
       def update_endpoint_key
         try_with_rescue_in_session do
           # Read address
           ipv6_address = EnfCli::IPV6.new options[:address]
 
           # read key
-          keyfile = EnfCli::expand_path(options['public-key-in-file'])
+          keyfile = EnfCli::expand_path(options["public-key-in-file"])
           key = read_ec_key_file keyfile
           pub = key.public_key
 
           # update endpoint
           update_endpoint_credentials ipv6_address, pub
-        end        
+        end
       end
 
       desc "update-endpoint-cert", "Update an IPV6 endpoint's credentials"
-      method_option :'cert-in-file', :type => :string, :required => true, :banner => "<file>"      
+      method_option :'cert-in-file', :type => :string, :required => true, :banner => "<file>"
+
       def update_endpoint_cert
         try_with_rescue_in_session do
           # read options
-          certfile = EnfCli::expand_path(options['cert-in-file'])
+          certfile = EnfCli::expand_path(options["cert-in-file"])
           raise EnfCli::ERROR, "#{certfile} does not exist!" unless File.exists?(certfile)
 
           # read cert file
@@ -491,8 +500,8 @@ module EnfCli
           subject = cert.subject.to_a
 
           # get ipv6 CN record
-          cn = subject.select { |d| "CN".eql?( d[0].upcase ) }
-          ipv6_address =  EnfCli::IPV6.new cn[0][1]
+          cn = subject.select { |d| "CN".eql?(d[0].upcase) }
+          ipv6_address = EnfCli::IPV6.new cn[0][1]
 
           # get the public key
           pub = cert.public_key.public_key
@@ -501,8 +510,6 @@ module EnfCli
           update_endpoint_credentials ipv6_address, pub
         end
       end
-      
-    end    
+    end
   end
 end
-

data/lib/enfcli/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2018 Xaptum,Inc
+# Copyright 2018-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.
@@ -14,5 +14,5 @@
 # limitations under the License.
 #
 module EnfCli
-  VERSION = '4.0.0'
+  VERSION = "5.0.0-alpha"
 end