oxdperl/lib/OxdPackages/GetClientToken.pm
#!/usr/bin/perl
# GetClientToken.pm, a number as an object
#
# Gluu-oxd-library
#
# An open source application library for Perl
#
# This content is released under the MIT License (MIT)
#
# Copyright (c) 2018, Gluu inc, USA, Austin
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# @package Gluu-oxd-library
# @version 3.1.3
# @author Sobhan Panda
# @author_email sobhan@centroxy.com
# @copyright Copyright (c) 2018, Gluu inc federation (https://gluu.org/)
# @license http://opensource.org/licenses/MIT MIT License
# @link https://gluu.org/
# @since Version 3.1.3
# @filesource
#/
use JSON::PP;
package GetClientToken; # This is the "Class"
use vars qw($VERSION);
$VERSION = '0.01';
use OxdPackages::OxdClient;
use base qw(OxdClient Class::Accessor);
#use base 'OxdClient';
use strict;
our @ISA = qw(OxdClient); # inherits from OxdClient
sub new {
my $class = shift;
my $self = {
# @var string _request_op_host Gluu server url
_request_op_host => shift,
# @var array _request_scope For getting needed scopes from gluu-server
_request_scope => [],
# @var string _request_client_id OpenID provider client id
_request_client_id => shift,
# @var string _request_client_secret OpenID provider client secret
_request_client_secret => shift,
_request_op_discovery_path => shift,
_request_authentication_method => shift,
_request_algorithm => shift,
_request_key_id=> shift,
# Response parameter from oxd-server
# It is basic parameter for other protocols
#
# @var string _response_access_token
_response_access_token => shift,
# @var string _response_expires_in
_response_expires_in => shift,
# @var string _response_refresh_token
_response_refresh_token => shift,
# Response parameter from oxd-server
#
# @var string _response_scope
_response_scope => shift,
};
#print "<br>";
bless $self, $class;
return $self;
}
sub _initialize {}
# @return string
sub getRequestClientSecret{
my( $self ) = @_;
return $self->{_request_client_secret};
}
# @param string $request_client_secret
sub setRequestClientSecret{
my ( $self, $request_client_secret ) = @_;
$self->{_request_client_secret} = $request_client_secret if defined($request_client_secret);
return $self->{_request_client_secret};
}
# @return string
sub getRequestClientId{
my( $self ) = @_;
return $self->{_request_client_id};
}
# @param string $request_client_id
sub setRequestClientId{
my ( $self, $request_client_id ) = @_;
$self->{_request_client_id} = $request_client_id if defined($request_client_id);
return $self->{_request_client_id};
}
# @param string $request_op_host
# @return void
sub setRequestOpHost {
my ( $self, $request_op_host ) = @_;
$self->{_request_op_host} = $request_op_host if defined($request_op_host);
return $self->{_request_op_host};
}
# @return string
sub getRequestOpHost {
my( $self ) = @_;
return $self->{_request_op_host};
}
# @return string
sub getRequestOpDiscoveryPath{
my( $self ) = @_;
return $self->{_request_op_discovery_path};
}
# @param string $request_op_discovery_path
# @return void
sub setRequestOpDiscoveryPath{
my ( $self, $request_op_discovery_path ) = @_;
$self->{_request_op_discovery_path} = $request_op_discovery_path if defined($request_op_discovery_path);
return $self->{_request_op_discovery_path};
}
# @return string
sub getRequestAuthenticationMethod {
my( $self ) = @_;
return $self->{_request_authentication_method};
}
# @param string $request_authentication_method
# @return void
sub setRequestAuthenticationMethod {
my ( $self, $request_authentication_method ) = @_;
$self->{_request_authentication_method} = $request_authentication_method if defined($request_authentication_method);
return $self->{_request_authentication_method};
}
# @return string
sub getRequestAlgorithm {
my( $self ) = @_;
return $self->{_request_algorithm};
}
# @param string $request_algorithm
# @return void
sub setRequestAlgorithm {
my ( $self, $request_algorithm ) = @_;
$self->{_request_algorithm} = $request_algorithm if defined($request_algorithm);
return $self->{_request_algorithm};
}
# @return string
sub getRequestKeyId {
my( $self ) = @_;
return $self->{_request_key_id};
}
# @param string $request_key_id
# @return void
sub setRequestKeyId {
my ( $self, $request_key_id ) = @_;
$self->{_request_key_id} = $request_key_id if defined($request_key_id);
return $self->{_request_key_id};
}
# @return array
sub getRequestScope{
my( $self ) = @_;
return $self->{_request_scope};
}
# @param array $request_scope
# @return void
sub setRequestScope{
my ( $self, $request_scope ) = @_;
$self->{_request_scope} = $request_scope if defined($request_scope);
return $self->{_request_scope};
}
# @return string
sub getResponseAccessToken {
my( $self ) = @_;
$self->{_response_access_token} = $self->getResponseData()->{access_token};
return $self->{_response_access_token};
}
# @return int
sub getResponseExpiresIn {
my( $self ) = @_;
$self->{_response_expires_in} = $self->getResponseData()->{expires_in};
return $self->{_response_expires_in};
}
# @return string
sub getResponseRefreshToken {
my( $self ) = @_;
$self->{_response_refresh_token} = $self->getResponseData()->{refresh_token};
return $self->{_response_refresh_token};
}
# @return string
sub getResponseScope {
my( $self ) = @_;
$self->{_response_scope} = $self->getResponseData()->{scope};
return $self->{_response_scope};
}
# Protocol command to oxd server
# @return void
sub setCommand{
# my $command = 'get_client_token';
my ( $self, $command ) = @_;
$self->{_command} = 'get_client_token';
return $self->{_command};
#return $command;
}
# Protocol command to oxd to http server
# @return void
sub sethttpCommand{
# my $httpCommand = 'get-client-token';
my ( $self, $httpCommand ) = @_;
$self->{_httpcommand} = 'get-client-token';
return $self->{_httpcommand};
#return $httpcommand;
}
# Method: setParams
# This method sets the parameters for get_client_token command.
# This module uses `request` method of OxdClient module for sending request to oxd-server
#
# Parameters:
#
# string $client_id - (Required) Client Id from Client registration
#
# string $client_secret - (Required) Client Secret. Must be used together with ClientId.
#
# string $op_host - (Required) Url that must points to a valid OpenID Connect Provider that supports client registration like Gluu Server.
#
# string $op_discovery_path - (Optional) Path to discovery document
#
# array $scope - (Optional) Scope
#
# string $authentication_method - (Optional) If value is missed then basic authentication is used. Otherwise it's possible to set `private_key_jwt` value for Private Key authentication.
#
# string $algorithm - (Optional) Required if authentication_method=private_key_jwt. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512
#
# string $key_id - (Optional) Required if authentication_method=private_key_jwt. It has to be valid key id from key store.
#
# Returns:
# void
#
# This module uses `getResponseObject` method of OxdClient module for getting response from oxd.
#
# *Example response from getResponseObject:*
# --- Code
# { "status": "ok", "data": { "access_token": "7ec389c5-64f8-49a3-a80c-e3e16d134bcb", "expires_in": 299, "refresh_token": null, "scope": "openid" } }
# ---
#
sub setParams{
my ( $self, $params ) = @_;
#use Data::Dumper;
my $paramsArray = {
"client_id"=> $self->getRequestClientId(),
"client_secret"=> $self->getRequestClientSecret(),
"op_host" => $self->getRequestOpHost(),
"op_discovery_path" => $self->getRequestOpDiscoveryPath(),
"scope" => $self->getRequestScope(),
"authentication_method" => $self->getRequestAuthenticationMethod(),
"algorithm" => $self->getRequestAlgorithm(),
"key_id" => $self->getRequestKeyId()
};
$self->{_params} = $paramsArray;
return $self->{_params};
#print Dumper( $params );
#return $paramsArray;
}
1; # this 1; is neccessary for our class to work