1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
|
package Web::Solid::Auth;
use Moo;
use Crypt::JWT;
use Data::Dumper;
use Data::UUID;
use Digest::SHA;
use HTTP::Link;
use HTTP::Request;
use HTTP::Server::PSGI;
use Log::Any ();
use LWP::UserAgent;
use JSON;
use MIME::Base64;
use Path::Tiny;
use URI::Escape;
use Plack::Request;
use Plack::Response;
use Web::Solid::Auth::Listener;
use Web::Solid::Auth::Util;
our $VERSION = "0.91";
has webid => (
is => 'ro' ,
required => 1
);
has redirect_uri => (
is => 'ro'
);
has cache => (
is => 'ro' ,
default => sub { $ENV{HOME} . "/.solid"}
);
has log => (
is => 'ro',
default => sub { Log::Any->get_logger },
);
has agent => (
is => 'lazy'
);
has listener => (
is => 'lazy'
);
has issuer => (
is => 'lazy'
);
has client_id => (
is => 'ro',
);
sub _build_agent {
my $ua = LWP::UserAgent->new(agent => "Web::Solid::Auth/$VERSION");
$ua;
}
sub _build_listener {
Web::Solid::Auth::Listener->new;
}
sub _build_issuer {
shift->get_openid_provider();
}
sub BUILD {
my $self = shift;
$self->{redirect_uri} //= $self->listener->redirect_uri;
}
sub listen {
my $self = shift;
$self->listener->run($self);
}
sub has_access_token {
my $self = shift;
my $cache_dir = $self->get_cache_dir;
my $access = path($cache_dir)->child("access.json");
$access->exists;
}
sub make_clean {
my $self = shift;
my $cache_dir = $self->get_cache_dir;
$self->log->info("cleaning cache directory $cache_dir");
my $openid = path($cache_dir)->child("openid.json");
$openid->remove if $openid->exists;
my $client = path($cache_dir)->child("client.json");
$client->remove if $client->exists;
my $access = path($cache_dir)->child("access.json");
$access->remove if $access->exists;
$self;
}
sub make_authorization_request {
my $self = shift;
my $redirect_uri = $self->redirect_uri;
my $registration_conf = $self->get_client_configuration;
my $openid_conf = $self->get_openid_configuration;
my $authorization_endpoint = $openid_conf->{authorization_endpoint};
my $client_id = $registration_conf->{client_id};
my $code_verifier = $self->make_random_string;
my $code_challenge = MIME::Base64::encode_base64url(Digest::SHA::sha256($code_verifier),'');
$code_challenge =~ s{=}{};
my $state = $self->make_random_string;
my $url = $self->make_url(
$authorization_endpoint, {
code_challenge => $code_challenge ,
code_challenge_method => 'S256' ,
state => $state ,
scope => 'openid profile offline_access' ,
client_id => $client_id ,
response_type => 'code' ,
redirect_uri => $redirect_uri ,
});
$self->{state} = $state;
$self->{code_verifier} = $code_verifier;
$self->log->info("generating authorization request: $url");
return $url;
}
sub make_access_token {
my ($self,$code) = @_;
die "need code" unless $code;
my $redirect_uri = $self->redirect_uri;
my $openid_conf = $self->get_openid_configuration;
my $registration_conf = $self->get_client_configuration;
my $token_endpoint = $openid_conf->{token_endpoint};
my $token_endpoint_auth_methods_supported = $openid_conf->{token_endpoint_auth_methods_supported} // [];
# Make an array out of an string...
$token_endpoint_auth_methods_supported =
ref($token_endpoint_auth_methods_supported) eq 'ARRAY' ?
$token_endpoint_auth_methods_supported :
[$token_endpoint_auth_methods_supported];
my $client_id = $registration_conf->{client_id};
my $client_secret = $registration_conf->{client_secret};
my $dpop_token = $self->make_token_for($token_endpoint,'POST');
$self->log->info("requesting access token at $token_endpoint");
my $token_request = {
grant_type => 'authorization_code' ,
client_id => $client_id ,
redirect_uri => $redirect_uri ,
code => $code ,
code_verifier => $self->{code_verifier}
};
my %headers = (
'Content-Type' => 'application/x-www-form-urlencoded' ,
DPoP => $dpop_token
);
if (grep(/^client_secret_basic/, @$token_endpoint_auth_methods_supported)) {
$self->log->info('using client_secret_basic');
$headers{'Authorization'} = 'Basic ' . MIME::Base64::encode_base64url("$client_id:$client_secret");
}
elsif (grep(/^client_secret_post/, @$token_endpoint_auth_methods_supported)) {
$self->log->info('using client_secret_post');
$token_request->{client_secret} = $client_secret;
}
my $data = $self->post( $token_endpoint, $token_request , %headers );
return undef unless $data;
$data = decode_json($data);
$self->log->infof("received: %s", $data);
my $cache_dir = $self->get_cache_dir;
path($cache_dir)->mkpath unless -d $cache_dir;
my $cache_file = path($cache_dir)->child("access.json")->stringify;
path($cache_file)->spew(encode_json($data));
return $data;
}
sub make_authentication_headers {
my ($self, $uri, $method) = @_;
my $access = $self->get_access_token;
return undef unless $access;
my $headers = {
Authorization => 'DPoP ' . $access->{access_token} ,
DPoP => $self->make_token_for($uri,$method)
};
return $headers;
}
sub get_cache_dir {
my $self = shift;
my $webid = $self->webid;
die "No webid set" unless $webid;
my $webid_sha = Digest::SHA::sha1_hex($webid);
my $cache_dir = sprintf "%s/%s"
, $self->cache
, Digest::SHA::sha1_hex($webid);
return $cache_dir;
}
sub get_access_token {
my $self = shift;
my $cache_dir = $self->get_cache_dir;
return undef unless path($cache_dir)->child("access.json")->exists;
my $cache_file = path($cache_dir)->child("access.json")->stringify;
$self->log->debug("reading $cache_file");
my $json = path("$cache_file")->slurp;
return undef unless $json;
return decode_json($json);
}
sub get_openid_provider {
my ($self, $webid) = @_;
$webid //= $self->webid;
my $res = $self->options($webid);
return undef unless $res;
my $link = $res->header('Link');
my @links = HTTP::Link->parse($link);
my $issuer;
for (@links) {
if ($_->{relation} eq 'http://openid.net/specs/connect/1.0/issuer') {
$issuer = $_->{iri};
}
}
if ($issuer) {
return $issuer;
}
else {
# Try the webid to find the issuer
return $self->get_webid_openid_provider($webid);
}
}
sub get_webid_openid_provider {
my ($self, $webid) = @_;
$webid //= $self->webid;
# Lets try plain JSON parsing for fun..
my $res = $self->get($webid, 'Accept' => 'text/turtle');
return undef unless $res;
my $util = Web::Solid::Auth::Util->new;
my $model = $util->parse_turtle($res);
my $sparql =<<EOF;
SELECT ?oidcIssuer {
?subject <http://www.w3.org/ns/solid/terms#oidcIssuer> ?oidcIssuer .
}
EOF
my $issuer;
$util->sparql($model, $sparql, sub {
my $res = shift;
$issuer = $res->value('oidcIssuer')->as_string;
});
return $issuer;
}
sub get_client_configuration {
my $self = shift;
my $cache_dir = $self->get_cache_dir;
path($cache_dir)->mkpath unless -d $cache_dir;
my $openid_conf = $self->get_openid_configuration;
my $redirect_uri = $self->redirect_uri;
my $registration_endpoint = $openid_conf->{registration_endpoint};
my $cache_file = path($cache_dir)->child("client.json")->stringify;
unless (-f $cache_file) {
if ($self->client_id) {
$self->log->info("using client document at " . $self->client_id);
my $data = $self->get_json($self->client_id);
$self->log->debug("generating $cache_file");
path("$cache_file")->spew(encode_json($data));
}
else {
$self->log->info("registering client at $registration_endpoint");
# Dynamic register the client. We request the openid and profile
# scopes that are default for OpenID. The offline_access is
# to be able to request refresh_tokens (not yet implemented).
# The only safe response type is 'code' all other options send
# sensitive data over the front channel and shouldn't be used.
my $data = $self->post_json($registration_endpoint, {
grant_types => ["authorization_code", "refresh_token"],
redirect_uris => [ $redirect_uri ] ,
scope => "openid profile offline_access" ,
response_types => ["code"]
});
return undef unless $data;
$self->log->infof("received %s", $data);
$self->log->debug("generating $cache_file");
path("$cache_file")->spew(encode_json($data));
}
}
$self->log->debug("reading $cache_file");
my $json = path("$cache_file")->slurp;
return undef unless $json;
return decode_json($json);
}
sub get_openid_configuration {
my ($self) = @_;
my $issuer = $self->issuer;
# remove trailing slash (we will add it)
$issuer =~ s{\/$}{};
my $cache_dir = $self->get_cache_dir;
path($cache_dir)->mkpath unless -d $cache_dir;
my $cache_file = path($cache_dir)->child("openid.json")->stringify;
unless (-f $cache_file) {
my $url = "$issuer/.well-known/openid-configuration";
$self->log->info("reading openid configruation from $url");
# Get the well known openid
my $data = $self->get_json($url);
return undef unless $data;
$self->log->infof("received %s", $data);
$self->log->debug("generating $cache_file");
path($cache_file)->spew(encode_json($data));
}
$self->log->debug("reading $cache_file");
my $json = path($cache_file)->slurp;
return undef unless $json;
return decode_json($json);
}
sub get_key_configuration {
my ($self) = @_;
my $cache_dir = $self->get_cache_dir;
path($cache_dir)->mkpath unless -d $cache_dir;
my $cache_file = path($cache_dir)->child("key.json")->stringify;
unless (-f $cache_file) {
# Create an P-256 elliptic curve key we will use in DPoP
# headers.
my $pk = Crypt::PK::ECC->new();
$pk->generate_key('secp256r1');
$self->log->debug("generating $cache_file");
path($cache_file)->spew(encode_json({
public => $pk->export_key_jwk('public') ,
private => $pk->export_key_jwk('private')
}));
}
$self->log->debug("reading $cache_file");
my $json = path($cache_file)->slurp;
return undef unless $json;
my $pk = Crypt::PK::ECC->new();
my $priv = decode_json($json)->{private};
$pk->import_key(\$priv);
return $pk;
}
## Networking
sub get {
my ($self, $url, %opts) = @_;
my $response = $self->agent->get($url, %opts);
unless ($response->is_success) {
$self->log->errorf("failed to GET($url): %s" , $response);
return undef;
}
return $response->decoded_content;
}
sub get_json {
my ($self, $url, %opts) = @_;
return decode_json($self->get($url, %opts));
}
sub post {
my ($self, $url, $data, %opts) = @_;
my $response = $self->agent->post($url,
%opts,
Content => $data
);
unless ($response->is_success) {
$self->log->errorf("failed to POST($url): %s",$response);
return undef;
}
return $response->decoded_content;
}
sub post_json {
my ($self, $url, $data, %opts) = @_;
$opts{'Content-Type'} //= 'application/json';
my $response = $self->agent->post($url,
%opts ,
Content => encode_json($data)
);
unless ($response->is_success) {
$self->log->errorf("failed to POST($url): %s",$response);
return undef;
}
return decode_json($response->decoded_content);
}
sub options {
my ($self, $url) = @_;
my $response = $self->agent->request(
HTTP::Request->new(OPTIONS => $url)
);
unless ($response->is_success) {
$self->log->errorf("failed to OPTIONS($url): %s" , $response);
return undef;
}
return $response;
}
sub make_url {
my ($self, $url,$params) = @_;
my @qparam = ();
for my $key (keys %{$params // {} }) {
my $value = URI::Escape::uri_escape($params->{$key});
push @qparam , "$key=$value";
}
if (@qparam) {
$url .= "?" . join("&", @qparam);
}
$url;
}
# Crypto
sub make_random_string {
my $self = shift;
my $str = MIME::Base64::encode_base64url(
Data::UUID->new->create() .
Data::UUID->new->create() .
Data::UUID->new->create()
);
$str;
}
sub make_token_for {
my ($self, $uri, $method) = @_;
# With DPoP headers access_tokens can be protected. When requesting
# an access_token from a token_endpoint a DPoP headers is included
# which contains our public key (inside the signed token header).
# Our public key will then be part of the returned access_token.
#
# When later on you will send the access_token to a resource provider
# it can check the signed DPoP header in combination with our public
# key in the access_token that you are in posession of the private key
# that matches the public key in the access_token.
#
# In this way, when some evil resource provider steals your access_token
# it can't be reused without your private key.
my $pk = $self->get_key_configuration;
my $header = {
typ => 'dpop+jwt' ,
alg => 'ES256' ,
jwk => JSON::decode_json($pk->export_key_jwk('public')) ,
};
$self->log->debugf("DPoP(header) %s" , $header);
my $payload = {
# A jti is a random string that protects the token_endpoint server
# against replay attacks
jti => $self->make_random_string,
# Limits the DPoP token only to this method
htm => $method ,
# Limits the DPop token only to this uri
htu => $uri ,
# The time this token was issued
iat => time ,
};
$self->log->debugf("DPoP(payload) %s" , $payload);
my $token = Crypt::JWT::encode_jwt(
payload => $payload ,
key => $pk ,
alg => 'ES256' ,
extra_headers => $header
);
return $token;
}
1;
__END__
=head1 NAME
Web::Solid::Auth - A Perl Solid Web Client
=head1 SYNOPSIS
# On the command line
# Set your default webid
export SOLID_WEBID=https://timbl.inrupt.net/profile/card#me
# Authentication to a pod
solid_auth.pl authenticate
# Get the http headers for a authenticated request
solid_auth.pl headers GET https://timbl.inrupt.net/inbox/
# Act like a curl command and fetch authenticated content
solid_auth.pl curl -X GET https://timbl.inrupt.net/inbox/
# Add some data
solid_auth.pl curl -X POST \
-H "Content-Type: text/plain" \
-d "abc" \
https://timbl.inrupt.net/public/
# Add a file
solid_auth.pl curl -X PUT \
-H "Content-Type: application/ld+json" \
-d "@myfile.jsonld" \
https://timbl.inrupt.net/public/myfile.jsonld
# Set a solid base url
export SOLID_REMOTE_BASE=https://timbl.inrupt.net
# List all resources on some Pod path
solid_auth.pl list /public/
# Get some data
solid_auth.pl get /inbox/
# Post some data
solid_auth.pl post /inbox/ myfile.jsonld
# Put some data
solid_auth.pl put /public/myfile.txt myfile.txt
# Create a folder
solid_auth.pl put /public/mytestfolder/
# Delete some data
solid_auth.pl delete /public/myfile.txt
# Mirror a resource, container or tree
solid_auth.pl mirror /public/ ./my_copy
# Upload a directory to the pod
# Add the -x option to do it for real (only a test without this option)
solid_auth.pl -r upload /data/my_copy /public/
# Clean all files in a container
# Add the -x option to do it for real (only a test without this option)
solid_auth.pl --keep clean /demo/
# Clean a complete container
# Add the -x option to do it for real (only a test without this option)
solid_auth.pl -r clean /demo/
# In a perl program
use Web::Solid::Auth;
use Web::Solid::Auth::Listener;
# Create a new authenticator for a pod
my $auth = Web::Solid::Auth->new(webid => $webid);
# Or tune a listerner
my $auth = Web::Solid::Auth->new(
webid => $webid ,
listener => Web::Solid::Auth::Listener->new(
scheme => 'https'
host => 'my.server.org'
port => '443' ,
path => '/mycallback'
)
);
# Or, in case you have your own callback server
my $auth = Web::Solid::Auth->new(
webid => $webid,
redirect_uri => 'https://my.server.org/mycallback'
);
# Generate a url for the user to authenticate
my $auth_url = $auth->make_authorization_request;
# Listen for the oauth server to return tokens
# the built-in listener for feedback from the openid provider
# Check the code of Web::Solid::Auth::Listener how to
# do this inside your own Plack application
$auth->listen;
####
# If you already have access_tokens from previous step
if ($auth->has_access_token) {
# Fetch the Authentication and DPoP HTTP headers for a
# request to an authorized resource
my $headers = $auth->make_authentication_headers($resource_url,$http_method);
#..do you curl..lwp::agent..or what ever with the headers
}
=head1 INSTALLATION
See the L<https://metacpan.org/dist/Web-Solid-Auth/source/INSTALL> file in the
distribution.
=head1 DESCRIPTION
This is a Solid-OIDC implementation of a connection class for the Solid
server. Use the L<solid_auth> command as a command line implementation.
Check out the C<example> directory for a demo web application.
=head1 CONFIGURATION
=over
=item webid
The Solid Webid to authenticate.
=item cache
The location of the cache directory with connection parameters.
=back
=head1 METHODS
=over
=item has_access_token()
Returns a true value when a cache contains an access token for the C<webid>.
=item make_clean()
Clear the cache directory.
=item make_authorization_request()
Return an authorization URL that the use should open to authenticate this
application.
=item make_access_token($code)
When on the redirect url you get a C<code> from the authentication server you
can use this method to get an access_token for the code.
=item listen()
Create a small built-in web server to listen for token responses from the
authentication server.
=item get_access_token()
Return the cached access_token.
=back
=head1 SEE ALSO
L<solid_auth>
=head1 INSPIRATION
This was very much inspired by the Python solid-flask code by
Rai L<http://agentydragon.com> at L<https://gitlab.com/agentydragon/solid-flask>,
and Jeff Zucker's <https://github.com/jeff-zucker> Solid-Shell at L<https://www.npmjs.com/package/solid-shell>.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021 by Patrick Hochstenbach.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
=encoding utf8
=cut
|