| 1 | #/usr/bin/env perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @file Authority.pm | ||
| 5 | # | ||
| 6 | # @brief API::Eulerian::EDW Authority module used to get API::Eulerian::EDW Data Warehouse | ||
| 7 | # Access/Session Tokens. | ||
| 8 | # | ||
| 9 | # @author Thorillon Xavier:x.thorillon@eulerian.com | ||
| 10 | # | ||
| 11 | # @date 25/11/2021 | ||
| 12 | # | ||
| 13 | # @version 1.0 | ||
| 14 | # | ||
| 15 | ############################################################################### | ||
| 16 | # | ||
| 17 | # Setup perl package name | ||
| 18 | # | ||
| 19 | package API::Eulerian::EDW::Authority; | ||
| 20 | # | ||
| 21 | # Enforce compilor rules | ||
| 22 | # | ||
| 23 | use strict; use warnings; | ||
| 24 | # | ||
| 25 | # Import API::Eulerian::EDW::Request ( HTTP requests ) | ||
| 26 | # | ||
| 27 | use API::Eulerian::EDW::Request; | ||
| 28 | # | ||
| 29 | # Import API::Eulerian::EDW::Status | ||
| 30 | # | ||
| 31 | use API::Eulerian::EDW::Status; | ||
| 32 | # | ||
| 33 | # URL domain matching platform names | ||
| 34 | # | ||
| 35 | my %DOMAINS = ( | ||
| 36 | 'fr' => 'api.eulerian.com', | ||
| 37 | 'ca' => 'api.eulerian.ca', | ||
| 38 | 'gv' => 'api.gouv.eulerian.fr', | ||
| 39 | ); | ||
| 40 | # | ||
| 41 | # URL Application matching Token Kind. | ||
| 42 | # | ||
| 43 | my %KINDS = ( | ||
| 44 | 'session' => '/er/account/get_dw_session_token.json?ip=', | ||
| 45 | 'access' => '/er/account/get_dw_access_token.json?ip=', | ||
| 46 | ); | ||
| 47 | |||
| 48 | # | ||
| 49 | # @brief Get valid HTTP Authorization bearer used to access API::Eulerian::EDW | ||
| 50 | # Data Warehouse Platform. | ||
| 51 | # | ||
| 52 | # @param $class - API::Eulerian::EDW Authority class. | ||
| 53 | # @param $kind - API::Eulerian::EDW Authority token kind. | ||
| 54 | # @param $platform - API::Eulerian::EDW Authority Platform. | ||
| 55 | # @param $grid - API::Eulerian::EDW Data Warehouse Grid. | ||
| 56 | # @param $ip - Peer IP. | ||
| 57 | # @param $token - API::Eulerian::EDW Token. | ||
| 58 | # | ||
| 59 | # @return API::Eulerian::EDW::Status | ||
| 60 | # | ||
| 61 | sub bearer | ||
| 62 | { | ||
| 63 | my ( $class, $kind, $platform, $platform_auth, $grid, $ip, $token ) = @_; | ||
| 64 | my $response; | ||
| 65 | my $status; | ||
| 66 | my $code; | ||
| 67 | my $json; | ||
| 68 | |||
| 69 | # Get URL used to request API::Eulerian::EDW Authority for Token. | ||
| 70 | $status = $class->_url( $kind, $platform, $platform_auth, $grid, $ip, $token ); | ||
| 71 | # Handle errors | ||
| 72 | if( ! $status->error() ) { | ||
| 73 | # Request API::Eulerian::EDW Authority | ||
| 74 | $status = API::Eulerian::EDW::Request->get( $status->{ url } ); | ||
| 75 | # Get HTTP response | ||
| 76 | $response = $status->{ response }; | ||
| 77 | # Get HTTP response code | ||
| 78 | $code = $response->code; | ||
| 79 | # We expect JSON reply data | ||
| 80 | $json = API::Eulerian::EDW::Request->json( $response ); | ||
| 81 | if( $json && ( $code == 200 ) ) { | ||
| 82 | $status = $json->{ error } ? | ||
| 83 | $class->_error( $code, $json->{ error_msg } ) : | ||
| 84 | $class->_success( $kind, $json ); | ||
| 85 | } else { | ||
| 86 | $status = $class->_error( | ||
| 87 | $code, $json ? | ||
| 88 | encode_json( $json ) : | ||
| 89 | $response->decoded_content | ||
| 90 | ); | ||
| 91 | } | ||
| 92 | } | ||
| 93 | |||
| 94 | return $status; | ||
| 95 | } | ||
| 96 | # | ||
| 97 | # @brief Get API::Eulerian::EDW Authority URL used to retrieve Session/Access Token | ||
| 98 | # to API::Eulerian::EDW Data Warehouse Platform. | ||
| 99 | # | ||
| 100 | # @param $class - API::Eulerian::EDW::Authority Class. | ||
| 101 | # @param $kind - API::Eulerian::EDW Data Warehouse Token Kind. | ||
| 102 | # @param $platform - API::Eulerian::EDW Data Warehouse Platform name. | ||
| 103 | # @param $platform_auth - API::Eulerian::EDW Data WareHouse Platform Auth to use. | ||
| 104 | # @param $grid - API::Eulerian::EDW Data Warehouse Site Grid name. | ||
| 105 | # @param $ip - IP of API::Eulerian::EDW Data Warehouse Peer. | ||
| 106 | # @param $token - API::Eulerian::EDW Token. | ||
| 107 | # | ||
| 108 | # @return API::Eulerian::EDW::Status | ||
| 109 | # | ||
| 110 | sub _url | ||
| 111 | { | ||
| 112 | my ( $class, $kind, $platform, $platform_auth, $grid, $ip, $token ) = @_; | ||
| 113 | my $domain; | ||
| 114 | # | ||
| 115 | # Sanity check mandatories arguments | ||
| 116 | # | ||
| 117 | if( ! ( defined( $grid ) && length( $grid ) > 0 ) ) { | ||
| 118 | return $class->_error( | ||
| 119 | 406, "Mandatory argument 'grid' is missing or invalid" | ||
| 120 | ); | ||
| 121 | } elsif( ! ( defined( $ip ) && length( $ip ) > 0 ) ) { | ||
| 122 | return $class->_error( | ||
| 123 | 406, "Mandatory argument 'ip' is missing" | ||
| 124 | ); | ||
| 125 | } elsif( ! ( defined( $token ) && length( $token ) > 0 ) ) { | ||
| 126 | return $class->_error( | ||
| 127 | 406, "Mandatory argument 'token' is missing" | ||
| 128 | ); | ||
| 129 | } | ||
| 130 | # | ||
| 131 | # URL formats are : | ||
| 132 | # | ||
| 133 | # Start : | ||
| 134 | # | ||
| 135 | # https://<grid>.<domain>/ea/v2/<token>/er/account/ | ||
| 136 | # | ||
| 137 | # Session token : | ||
| 138 | # | ||
| 139 | # <Start>get_dw_session_token.json?ip=<ip>&output-as-kv=1 | ||
| 140 | # | ||
| 141 | # Access token : | ||
| 142 | # | ||
| 143 | # <Start>get_dw_access_token.json?ip=<ip>&output-as-kv=1 | ||
| 144 | # | ||
| 145 | my $target_platform = $platform; | ||
| 146 | if ( defined $platform_auth | ||
| 147 | && ($platform ne $platform_auth) ) { | ||
| 148 | $target_platform = $platform_auth; | ||
| 149 | } | ||
| 150 | if( ! ( $kind = $KINDS{ $kind } ) ) { | ||
| 151 | return $class->_error( 406, "Invalid token kind : $kind" ); | ||
| 152 | } elsif( ! ( $domain = $DOMAINS{ $target_platform } ) ) { | ||
| 153 | return $class->_error( 506, "Invalid platform : $target_platform" ); | ||
| 154 | } else { | ||
| 155 | my $status = API::Eulerian::EDW::Status->new(); | ||
| 156 | my $url; | ||
| 157 | |||
| 158 | $url = 'https://'; | ||
| 159 | $url .= $grid . '.'; | ||
| 160 | $url .= $domain . '/ea/v2/'; | ||
| 161 | $url .= $token . $kind; | ||
| 162 | $url .= $ip . '&output-as-kv=1'; | ||
| 163 | $status->{ url } = $url; | ||
| 164 | |||
| 165 | return $status; | ||
| 166 | } | ||
| 167 | } | ||
| 168 | # | ||
| 169 | # @brief Return Error on API::Eulerian::EDW Authority Services. | ||
| 170 | # | ||
| 171 | # @param $class - API::Eulerian::EDW::Authority class. | ||
| 172 | # @param $code - HTTP Error code. | ||
| 173 | # @param $message - Error message. | ||
| 174 | # | ||
| 175 | # return API::Eulerian::EDW::Status | ||
| 176 | # | ||
| 177 | sub _error | ||
| 178 | { | ||
| 179 | my ( $class, $code, $message ) = @_; | ||
| 180 | my $status = API::Eulerian::EDW::Status->new(); | ||
| 181 | $status->error( 1 ); | ||
| 182 | $status->code( $code ); | ||
| 183 | $status->msg( $message ); | ||
| 184 | return $status; | ||
| 185 | } | ||
| 186 | # | ||
| 187 | # @brief Return Success on API::Eulerian::EDW Authority Services. | ||
| 188 | # | ||
| 189 | # @param $class - API::Eulerian::EDW::Authority class. | ||
| 190 | # @param $kind - Token kind. | ||
| 191 | # @param $json - Json reply. | ||
| 192 | # | ||
| 193 | # @return API::Eulerian::EDW::Status | ||
| 194 | # | ||
| 195 | sub _success | ||
| 196 | { | ||
| 197 | my ( $class, $kind, $json ) = @_; | ||
| 198 | my $status = API::Eulerian::EDW::Status->new(); | ||
| 199 | my $row = $json->{ data }->{ rows }->[ 0 ]; | ||
| 200 | $status->{ bearer } = 'bearer ' . $row->{ $kind . '_token' }; | ||
| 201 | return $status; | ||
| 202 | } | ||
| 203 | # | ||
| 204 | # End up perl module properly | ||
| 205 | # | ||
| 206 | 1; | ||
| 207 | |||
| 208 | __END__ |