- version: 3.03

- new: support for API Basic authorizations

Author: GomoR

Changes

@@ -1,5 +1,8 @@
 Revision history for Perl extension Metabrik::Client::Onyphe.
 
+3.03 Wed  7 Dec 07:49:50 CET 2022
+   - new: support for API Basic authorizations
+
 3.02 Tue 13 Sep 11:28:31 CEST 2022
    - new: support for calculated fields in Search API
 

bin/onyphe

@@ -42,6 +42,7 @@ GetOptions(
    "apitrackquery=i" => \$lopts{apitrackquery}, # -apitrackquery 1
    "apicalculated=i" => \$lopts{apicalculated}, # -apicalculated 1
    "apikeepalive=i" => \$lopts{apikeepalive},   # -apikeelalive 1
+   "apiauth=s" => \$lopts{apiauth},             # -apiauth user:pass
    "wait=i" => \$lopts{wait},                   # -wait 3
    # API options:
    "category=s" => \$lopts{category},  # -category datascan,synscan
@@ -87,6 +88,7 @@ $cli->apisize($lopts{apisize});
 $cli->apitrackquery($lopts{apitrackquery});
 $cli->apicalculated($lopts{apicalculated});
 $cli->apikeepalive($lopts{apikeepalive});
+$cli->apiauth($lopts{apiauth});
 $cli->wait($lopts{wait});
 
 # Set API options:

lib/Metabrik/Api/Onyphe.pm

@@ -7,7 +7,7 @@ package Metabrik::Api::Onyphe;
 use strict;
 use warnings;
 
-our $VERSION = '3.02';
+our $VERSION = '3.03';
 
 use base qw(Metabrik::Client::Rest);
 
@@ -21,6 +21,7 @@ sub brik_properties {
          url => [ qw(url) ],
          key => [ qw(key) ],
          wait => [ qw(seconds) ],
+         auth => [ qw(user:pass) ],
          _maxpage => [ qw(INTERNAL) ],
          _sj => [ qw(INTERNAL) ],
       },
@@ -49,6 +50,7 @@ sub brik_properties {
       },
       require_modules => {
          'Metabrik::String::Json' => [ ],
+         'Metabrik::String::Base64' => [ ],
          'Metabrik::File::Text' => [ ],
          'AnyEvent' => [ ],
          'AnyEvent::HTTP' => [ ],
@@ -81,9 +83,17 @@ sub api_standard {
    my $wait = $self->wait;
    my $url = $self->url;
    my $key = $self->key;
+   my $auth = $self->auth;
+   my ($username, $password); ($username, $password) = split(':', $auth)
+      if defined($auth);
+
+   if (defined($username) && defined($password)) {
+      $self->username($username);
+      $self->password($password);
+   }
 
    $self->add_headers({
-      'Authorization' => "apikey $key",
+      'Authorization' => "bearer $key",
       'Content-Type' => 'application/json',
    });
 
@@ -103,8 +113,16 @@ sub api_standard {
             push @args, $k.'='.$arg->{$k};
          }
       }
+      if (defined($username) && defined($password)) {
+         push @args, "k=$key";
+      }
       $url .= '?'.join('&', @args);
    }
+   else {
+      if (defined($username) && defined($password)) {
+         $url .= '?k='.$key;
+      }
+   }
 
    $self->log->verbose("api_standard: using url[$url]");
 
@@ -169,6 +187,16 @@ sub api_streaming {
    my $sj = $self->_sj;
    my $url = $self->url;
    my $key = $self->key;
+   my $auth = $self->auth;
+   my ($username, $password); ($username, $password) = split(':', $auth)
+      if defined($auth);
+
+   my $basic;
+   if (defined($username) && defined($password)) {
+      my $sb = Metabrik::String::Base64->new_from_brik_init($self)
+         or return;
+      $basic = "Basic ".$sb->encode($auth);
+   }
 
    if ($req eq "GET" && defined($oql)) {
       $oql = URI::Escape::uri_escape_utf8($oql);
@@ -186,8 +214,16 @@ sub api_streaming {
             push @args, $k.'='.$arg->{$k};
          }
       }
+      if (defined($username) && defined($password)) {
+         push @args, "k=$key";
+      }
       $url .= '?'.join('&', @args);
    }
+   else {
+      if (defined($username) && defined($password)) {
+         $url .= '?k='.$key;
+      }
+   }
 
    $self->log->verbose("api_streaming: using url[$url]");
 
@@ -204,6 +240,8 @@ sub api_streaming {
 
    my $cv = AnyEvent->condvar;
 
+   my $authorization = defined($basic) ? $basic : "bearer $key";
+
    my @args = ( $url );
    if ($req eq "POST") {
       push @args, $oql;
@@ -212,7 +250,7 @@ sub api_streaming {
       # For each loop of processing, let callback work during X before sending a timeout.
       timeout => 3600,
       headers => {
-         'Authorization' => "apikey $key",
+         'Authorization' => $authorization,
          'Content-Type' => "application/json",
       },
       on_body => sub {

lib/Metabrik/Client/Onyphe.pm

@@ -5,7 +5,7 @@ package Metabrik::Client::Onyphe;
 use strict;
 use warnings;
 
-our $VERSION = '3.02';
+our $VERSION = '3.03';
 
 use base qw(Metabrik);
 
@@ -26,6 +26,7 @@ sub brik_properties {
          apitrackquery => [ qw(0|1) ],
          apicalculated => [ qw(0|1) ],
          apikeepalive => [ qw(0|1) ],
+         apiauth => [ qw(user:pass) ],
          wait => [ qw(seconds) ],
          # API options:
          category => [ qw(category|categories) ],
@@ -85,12 +86,14 @@ sub ao {
 
    my $apiurl = $self->apiurl;
    my $apikey = $self->apikey;
+   my $apiauth = $self->apiauth;
 
    $self->brik_help_run_undef_arg('ao', $apiurl) or return;
    $self->brik_help_run_undef_arg('ao', $apikey) or return;
 
    $self->_ao->url($apiurl);
    $self->_ao->key($apikey);
+   $self->_ao->auth($apiauth);
 
    return $self->_ao;
 }

lib/Metabrik/Client/Onyphe/Function.pm

@@ -5,7 +5,7 @@ package Metabrik::Client::Onyphe::Function;
 use strict;
 use warnings;
 
-our $VERSION = '3.02';
+our $VERSION = '3.03';
 
 use base qw(Metabrik::Client::Onyphe);