pike.git/lib/modules/Auth.pmod/OAuth2.pmod:5f58bdeecb41320455102b95b9180cba3c5d04f5

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 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 //! OAuth2 client //! //! A base OAuth2 class can be instantiated either via @[`()] //! (@tt{Auth.OAuth2(params...)@}) or via @[Auth.OAuth2.Base()]. #ifdef SOCIAL_REQUEST_DEBUG # define TRACE(X...) werror("%s:%d: %s", basename(__FILE__),__LINE__,sprintf(X)) #else # define TRACE(X...) 0 #endif //! Instantiate a generic OAuth2 @[Base] class. //! //! @param client_id //! The application ID //! //! @param client_secret //! The application secret //! //! @param redirect_uri //! Where the authorization page should redirect back to. This must be a //! fully qualified domain name. This can be set/overridden in //! @[Base()->get_auth_uri()] and/or @[Base()->set_redirect_uri()]. //! //! @param scope //! Extended permissions to use for this authentication. This can be //! set/overridden in @[Base()->get_auth_uri()]. Base `()(string client_id, string client_secret, void|string redirect_uri, void|string|array(string)|multiset(string) scope) { return Base(client_id, client_secret, redirect_uri, scope); } //! Generic OAuth2 client class. class Base { //! Creates an OAuth2 object //! //! @param client_id //! The application ID //! //! @param client_secret //! The application secret //! //! @param redirect_uri //! Where the authorization page should redirect back to. This must be a //! fully qualified domain name. This can be set/overridden in //! @[get_auth_uri()] and/or @[set_redirect_uri()]. //! //! @param scope //! Extended permissions to use for this authentication. This can be //! set/overridden in @[get_auth_uri()]. protected void create(string client_id, string client_secret, void|string redirect_uri, void|string|array(string)|multiset(string) scope) { _client_id = client_id; _client_secret = client_secret; _redirect_uri = redirect_uri || _redirect_uri; _scope = scope || _scope; } //! Grant types enum GrantType { //! GRANT_TYPE_AUTHORIZATION_CODE = "authorization_code", //! GRANT_TYPE_IMPLICIT = "implicit", //! GRANT_TYPE_PASSWORD = "password", //! GRANT_TYPE_CLIENT_CREDENTIALS = "client_credentials", //! GRANT_TYPE_JWT = "urn:ietf:params:oauth:grant-type:jwt-bearer", //! GRANT_TYPE_REFRESH_TOKEN = "refresh_token" } //! Response types enum ResponseType { //! RESPONSE_TYPE_CODE = "code", //! RESPONSE_TYPE_TOKEN = "token" } //! Getter for @expr{access_token@} string `access_token() { return gettable->access_token; } //! Can be used to set a stored access_token. Will also set creation and //! expiration time. This can be useful in apps that support non-expiring //! authentications. void `access_token=(string value) { gettable->access_token = value; gettable->created = time(); gettable->expires = time() + (3600); } //! Getter for @expr{refresh_token@} string `refresh_token() { return gettable->refresh_token; } //! Getter for @expr{token_type@} string `token_type() { return gettable->token_type; } //! Getter for when the authentication @expr{expires@} Calendar.Second `expires() { return gettable->expires && Calendar.Second("unix", gettable->expires); } //! Getter for when the authentication was @expr{created@} Calendar.Second `created() { return Calendar.Second("unix", gettable->created); } //! Getter for the @expr{user@} mapping which may or may not be set. mapping `user() { return gettable->user; } //! Returns the application ID string get_client_id() { return _client_id; } //! Returns the application secret. string get_client_secret() { return _client_secret; } //! Returns the redirect uri string get_redirect_uri() { return _redirect_uri; } //! Returns the @expr{grant_type@} of the object string get_grant_type() { return _grant_type; } //! Set the grant type to use //! //! @param type void set_grant_type(GrantType type) { _grant_type = type; } #if constant(Crypto.RSA.State) // Pike 8.0 //! Get an @tt{access_token@} from a JWT. //! @url{http://jwt.io/@} //! //! @param jwt //! JSON string //! @param token_endpoint //! URI to the request access_token endpoint //! @param sub //! Email/id of the requesting user //! @param async_callback //! If given the request will be made asynchronously. //! The signature is: @tt{callback(bool, string)@}. //! If successful the second argument will be the result encoded //! with @[predef::encode_value()], which can be stored and later used to //! populate an instance via @[set_from_cookie()]. string get_token_from_jwt(string jwt, string token_endpoint, string|void sub, void|function(bool,string:void) async_cb) { mapping j = Standards.JSON.decode(jwt); mapping header = ([ "alg" : "RS256", "typ" : "JWT" ]); int now = time(); int exp = now + 3600; mapping claim = ([ "iss" : j->client_email, "scope" : get_valid_scopes(_scope), "aud" : token_endpoint, "exp" : exp, "iat" : now ]); if (sub) { claim->sub = sub; } string s = base64url_encode(Standards.JSON.encode(header)); s += "." + base64url_encode(Standards.JSON.encode(claim)); string key = //#if constant(Standards.PEM) Standards.PEM.simple_decode(j->private_key); //#else // Tools.PEM.Msg(j->private_key)->parts["PRIVATE KEY"]->decoded_body(); //#endif object x = [object(Standards.ASN1.Types.Sequence)] Standards.ASN1.Decode.simple_der_decode(key); string ss; //#if constant(Crypto.RSA.State) Crypto.RSA.State state; state = Standards.PKCS.RSA.parse_private_key(x->elements[-1]->value); ss = state->pkcs_sign(s, Crypto.SHA256); //#else /* Pike 7.8 cludge */ // Crypto.RSA rsa = Standards.PKCS.RSA.parse_private_key(x->elements[-1]->value); // Gmp.mpz sign = rsa->sign(s, Crypto.SHA256); // ss = sign->digits(256); //#endif s += "." + base64url_encode(ss); string body = "grant_type="+Protocols.HTTP.uri_encode(GRANT_TYPE_JWT)+"&"+ "assertion="+Protocols.HTTP.uri_encode(s); if (async_cb) { Protocols.HTTP.Query q = Protocols.HTTP.Query(); q->set_callbacks( lambda (Protocols.HTTP.Query qq, mixed ... args) { if (qq->status == 200) { mapping res = Standards.JSON.decode(q->data()); if (!decode_access_token_response(q->data())) { async_cb(false, sprintf("Bad result! Expected an access_token " "but none were found!\nData: %s.\n", q->data())); return; } async_cb(true, encode_value(gettable)); } }, lambda (Protocols.HTTP.Query qq, mixed ... args) { async_cb(false, "Connection failed!"); } ); Protocols.HTTP.do_async_method("POST", token_endpoint, 0, request_headers, q, body); return 0; } else { Protocols.HTTP.Query q; q = Protocols.HTTP.do_method("POST", token_endpoint, 0, request_headers, 0, body); if (q->status == 200) { mapping res = Standards.JSON.decode(q->data()); if (!decode_access_token_response(q->data())) { error("Bad result! Expected an access_token but none were found!" "\nData: %s.\n", q->data()); } return encode_value(gettable); } string ee = try_get_error(q->data()); error("Bad status (%d) in response: %s! ", q->status, ee||"Unknown error"); } } #endif /* Crypto.RSA.State */ protected string base64url_encode(string s) { s = MIME.encode_base64(s, 1); s = replace(s, ([ "==" : "", "+" : "-", "-" : "_" ])); return s; } //! Setter for the redirect uri //! //! @param uri void set_redirect_uri(string uri) { _redirect_uri = uri; } //! Returns the valid scopes multiset list_valid_scopes() { return valid_scopes; } //! Set access_type explicilty //! //! @param access_type //! Like: offline void set_access_type(string access_type) { _access_type = access_type; } //! Getter for the access type, if any string get_access_type() { return _access_type; } //! Set scopes void set_scope(string scope) { _scope = scope; } //! Returns the scope/scopes set, if any. mixed get_scope() { return _scope; } //! Check if @[scope] exists in this object //! //! @param scope int(0..1) has_scope(string scope) { if (!_scope || !sizeof(_scope)) return 0; string sp = search(_scope, ",") > -1 ? "," : search(_scope, " ") > -1 ? " " : ""; array p = map(_scope/sp, String.trim_all_whites); return has_value(p, scope); } //! Populate this object with the result from @[request_access_token()]. //! //! @throws //! An error if the decoding of @[encoded_value] fails. //! //! @param encoded_value //! The value from a previous call to @[request_access_token()] or //! @[refresh_access_token()]. //! //! @returns //! The object being called this_program set_from_cookie(string encoded_value) { mixed e = catch { gettable = decode_value(encoded_value); if (gettable->scope) _scope = gettable->scope; if (gettable->access_type) _access_type = gettable->access_type; return this; }; error("Unable to decode cookie! %s. ", describe_error(e)); } //! Returns an authorization URI. //! //! @param auth_uri //! The URI to the remote authorization page //! @param args //! Additional argument. string get_auth_uri(string auth_uri, void|mapping args) { Auth.Params p = Auth.Params(Auth.Param("client_id", _client_id), Auth.Param("response_type", _response_type)); if (args && args->redirect_uri || _redirect_uri) p += Auth.Param("redirect_uri", args && args->redirect_uri || _redirect_uri); if (STATE) p += Auth.Param("state", (string) Standards.UUID.make_version4()); if (args && args->scope || _scope) { string sc = get_valid_scopes(args && args->scope || _scope); if (sc && sizeof(sc)) { _scope = sc; p += Auth.Param("scope", sc); } } if (args && args->access_type || _access_type) { p += Auth.Param("access_type", args && args->access_type || _access_type); if (!_access_type && args && args->access_type) _access_type = args->access_type; } if (args) { m_delete(args, "scope"); m_delete(args, "redirect_uri"); p += args; } TRACE("auth_uri(%s)\n", (string) p["redirect_uri"]); return auth_uri + "?" + p->to_query(); } //! Requests an access token //! //! @throws //! An error if the access token request fails. //! //! @param oauth_token_uri //! An URI received from @[get_auth_url()]. //! //! @param code //! The code returned from the authorization page via @[get_auth_url()]. //! //! @param async_cb //! If given an async request will be made and this function will be called //! when the request is finished. The first argument passed to the callback //! will be @expr{true@} or @expr{false@} depending on if the request was //! successfull or not. The second argument will be a string. If the request //! failed it will be an error message. If it succeeded it will be the result //! as a string encoded with @[predef::encode_value()]. //! //! @returns //! If @expr{OK@} a Pike encoded mapping (i.e it's a string) is returned //! which can be used to populate an @[Auth.OAuth2] object at a later time. //! //! The mapping looks like //! @mapping //! @member string "access_token" //! @member int "expires" //! @member int "created" //! @member string "refresh_token" //! @member string "token_type" //! @endmapping //! //! Depending on the authorization service it might also contain more //! members. string request_access_token(string oauth_token_uri, string code, void|function(bool,string:void) async_cb) { TRACE("request_access_token: %O, %O\n", oauth_token_uri, code); Auth.Params p = get_default_params(); p += Auth.Param("code", code); if (async_cb) { do_query(oauth_token_uri, p, async_cb); return 0; } else { if (string s = do_query(oauth_token_uri, p)) return s; error("Failed getting access token! "); } } //! Refreshes the access token, if a refresh token exists in the object //! //! @param oauth_token_uri //! Endpoint of the authentication service //! @param async_cb //! If given an async request will be made and this function will be called //! when the request is finished. The first argument passed to the callback //! will be @expr{true@} or @expr{false@} depending on if the request was //! successfull or not. The second argument will be a string. If the request //! failed it will be an error message. If it succeeded it will be the result //! as a string encoded with @[predef::encode_value()]. string refresh_access_token(string oauth_token_uri, void|function(bool,string:void) async_cb) { TRACE("Refresh: %s @ %s\n", gettable->refresh_token, oauth_token_uri); if (!gettable->refresh_token) error("No refresh_token in object! "); Auth.Params p = get_default_params(GRANT_TYPE_REFRESH_TOKEN); p += Auth.Param("refresh_token", gettable->refresh_token); if (async_cb) { do_query(oauth_token_uri, p, async_cb); return 0; } else { if (string s = do_query(oauth_token_uri, p, async_cb)) { TRACE("Got result: %O\n", s); return s; } error("Failed refreshing access token! "); } } //! Send a request to @[oauth_token_uri] with params @[p] //! //! @param oauth_token_uri //! @param p //! @param async_cb //! If given an async request will be made and this function will be called //! when the request is finished. The first argument passed to the callback //! will be @expr{true@} or @expr{false@} depending on if the request was //! successfull or not. The second argument will be a string. If the request //! failed it will be an error message. If it succeeded it will be the result //! as a string encoded with @[predef::encode_value()]. protected string do_query(string oauth_token_uri, Auth.Params p, void|function(bool,string:void) async_cb) { int qpos = 0; if ((qpos = search(oauth_token_uri, "?")) > -1) { //string qs = oauth_token_uri[qpos..]; oauth_token_uri = oauth_token_uri[..qpos]; } TRACE("params: %O\n", p); TRACE("request_access_token(%s?%s)\n", oauth_token_uri, (string) p); if (async_cb) { Protocols.HTTP.Query q = Protocols.HTTP.Query(); q->set_callbacks( lambda (Protocols.HTTP.Query qq, mixed ... args) { if (q->status != 200) { string emsg = sprintf("Bad status (%d) in HTTP response! ", q->status); if (mapping reason = try_get_error(q->data())) emsg += sprintf("Reason: %O!\n", reason); async_cb(false, emsg); } else { if (decode_access_token_response(q->data())) async_cb(true, encode_value(gettable)); else async_cb(false, "Failed decoding response!"); } }, lambda (Protocols.HTTP.Query qq, mixed ... args) { TRACE("Failed callback\n"); async_cb(false, "Connection failed!"); } ); Protocols.HTTP.do_async_method("POST", oauth_token_uri, 0, request_headers, q, p->to_query()); return 0; } else { Protocols.HTTP.Session sess = Protocols.HTTP.Session(); Protocols.HTTP.Session.Request q; q = sess->post_url(oauth_token_uri, p->to_mapping()); TRACE("Query OK: %O : %O : %s\n", q, q->status(), q->data()); string c = q && q->data(); if (q->status() != 200) { string emsg = sprintf("Bad status (%d) in HTTP response! ", q->status()); if (mapping reason = try_get_error(c)) emsg += sprintf("Reason: %O!\n", reason); error(emsg); } TRACE("Got data: %O\n", c); if (decode_access_token_response(c)) return encode_value(gettable); } } //! Returns a set of default parameters //! //! @param grant_type protected Auth.Params get_default_params(void|string grant_type) { Auth.Params p; p = Auth.Params(Auth.Param("client_id", _client_id), Auth.Param("redirect_uri", _redirect_uri), Auth.Param("client_secret", _client_secret), Auth.Param("grant_type", grant_type || _grant_type)); if (STATE) { p += Auth.Param("state", (string)Standards.UUID.make_version4()); } return p; } //! Checks if the authorization is renewable. This is true if the //! @[Auth.OAuth2.Base()] object has been populated from //! @[Auth.OAuth2.Base()->set_from_cookie()], i.e the user has been //! authorized but the session has expired. int(0..1) is_renewable() { return !!gettable->refresh_token; } //! Checks if this authorization has expired int(0..1) is_expired() { // This means no expiration date was set from the API if (gettable->created && !gettable->expires) return 0; return gettable->expires ? time() > gettable->expires : 1; } //! Do we have a valid authentication int(0..1) is_authenticated() { return !!gettable->access_token && !is_expired(); } //! Cast method. If casted to @tt{string@} the @tt{access_token@} will be //! returned. If casted to @tt{int@} the @tt{expires@} timestamp will //! be returned. //! //! @param how mixed cast(string how) { switch (how) { case "string": return gettable->access_token; case "int": return gettable->expires; case "mapping": return gettable; } error("Can't cast %O to %s! ", object_program(this), how); } //! String formatting method string _sprintf(int t) { switch (t) { case 's': return gettable->access_token; } return sprintf("%O(%O, %O, %O, %O)", object_program(this), gettable->access_token, _redirect_uri, gettable->created && Calendar.Second("unix", gettable->created), gettable->expires && Calendar.Second("unix", gettable->expires)); } /* Internal API The internal API can be used by other classes inheriting this class */ //! A mapping of valid scopes for the API protected multiset(string) valid_scopes = (<>); //! Version of this implementation protected constant VERSION = "1.0"; //! User agent string protected constant USER_AGENT = "Mozilla 4.0 (Pike OAuth2 Client " + VERSION + ")"; //! Some OAuth2 verifiers need the STATE parameter. If this is not @tt{0@} //! a random string will be generated and the @tt{state@} parameter will be //! added to the request protected constant STATE = 0; //! The application ID protected string _client_id; //! The application secret protected string _client_secret; //! Where the authorization page should redirect to protected string _redirect_uri; //! The scope of the authorization. Limits the access protected string|array(string)|multiset(string) _scope; //! Access type of the request. protected string _access_type; //! @ul //! @item //! @[GRANT_TYPE_AUTHORIZATION_CODE] for apps running on a web server //! @item //! @[GRANT_TYPE_IMPLICIT] for browser-based or mobile apps //! @item //! @[GRANT_TYPE_PASSWORD] for logging in with a username and password //! @item //! @[GRANT_TYPE_CLIENT_CREDENTIALS] for application access //! @endul protected string _grant_type = GRANT_TYPE_AUTHORIZATION_CODE; //! @ul //! @item //! @[RESPONSE_TYPE_CODE] for apps running on a webserver //! @item //! @[RESPONSE_TYPE_TOKEN] for apps browser-based or mobile apps //! @endul protected string _response_type = RESPONSE_TYPE_CODE; //! Default request headers protected mapping request_headers = ([ "User-Agent" : USER_AGENT, "Content-Type" : "application/x-www-form-urlencoded" ]); protected constant json_decode = Standards.JSON.decode; protected constant Params = Auth.Params; protected constant Param = Auth.Param; protected mapping gettable = ([ "access_token" : 0, "refresh_token" : 0, "expires" : 0, "created" : 0, "token_type" : 0 ]); //! Returns a space separated list of all valid scopes in @[s]. //! @[s] can be a comma or space separated string or an array or multiset of //! strings. Each element in @[s] will be matched against the valid scopes //! set in the module inheriting this class. //! //! @param s protected string get_valid_scopes(string|array(string)|multiset(string) s) { if (!s) return ""; array r = ({}); if (stringp(s)) s = map(s/",", String.trim_all_whites); if (multisetp(s)) s = (array) s; if (!sizeof(valid_scopes)) r = s; foreach (s, string x) { if (valid_scopes[x]) r += ({ x }); } return r*" "; } //! Decode the response from an authentication call. If the response was ok //! the internal mapping @[gettable] will be populated with the //! members/variables in @[r]. //! //! @param r //! The response from @[do_query()] protected int(0..1) decode_access_token_response(string r) { if (!r) return 0; TRACE("Decode response: %s\n", r); mapping v = ([]); if (has_prefix(r, "access_token")) { foreach (r/"&", string s) { sscanf(s, "%s=%s", string key, string val); v[key] = val; } } else { if (catch(v = json_decode(r))) return 0; } if (!v->access_token) return 0; gettable->scope = _scope; gettable->created = time(); foreach (v; string key; string val) { if (search(key, "expires") > -1) gettable->expires = gettable->created + (int)val; else gettable[key] = val; } if (_access_type) { gettable->access_type = _access_type; } return 1; } //! Try to get an error message from @[data]. Only successful if @[data] //! is a JSON string and contains the key @tt{error@}. private mixed try_get_error(string data) { catch { mixed x = json_decode(data); return x->error; }; } #if 0 //! Parses a signed request //! //! @throws //! An error if the signature doesn't match the expected signature //! //! @param sign protected mapping parse_signed_request(string sign) { sscanf(sign, "%s.%s", string sig, string payload); function url_decode = lambda (string s) { return MIME.decode_base64(replace(s, ({ "-", "_" }), ({ "+", "/" }))); }; sig = url_decode(sig); mapping data = json_decode(url_decode(payload)); if (upper_case(data->algorithm) != "HMAC-SHA256") error("Unknown algorithm. Expected HMAC-SHA256"); string expected_sig; #if constant(Crypto.HMAC) # if constant(Crypto.SHA256) expected_sig = Crypto.HMAC(Crypto.SHA256)(payload)(_client_secret); # else error("No Crypto.SHA256 available in this Pike build! "); # endif #else error("Not implemented in this Pike version! "); #endif if (sig != expected_sig) error("Badly signed signature. "); return data; } #endif } //! This class is intended to be extended by classes implementing different //! OAuth2 services class Client { inherit Base; //! Authorization URI constant OAUTH_AUTH_URI = 0; //! Request access token URI constant OAUTH_TOKEN_URI = 0; //! Scope to set if none is set protected constant DEFAULT_SCOPE = 0; protected void create(string client_id, string client_secret, void|string redirect_uri, void|string|array(string)|multiset(string) scope) { ::create(client_id, client_secret, redirect_uri, scope); } #if constant(Crypto.RSA.State) //! Make an JWT (JSON Web Token) authentication string get_token_from_jwt(string jwt, void|string sub, void|function(bool,string:void) async_cb) { return ::get_token_from_jwt(jwt, OAUTH_TOKEN_URI, sub, async_cb); } #endif //! Returns an authorization URI. //! //! @param args //! Additional argument. string get_auth_uri(void|mapping args) { if ((args && !args->scope || !args) && DEFAULT_SCOPE) { if (!args) args = ([]); args->scope = DEFAULT_SCOPE; } return ::get_auth_uri(OAUTH_AUTH_URI, args); } //! Requests an access token //! //! @throws //! An error if the access token request fails. //! //! @param code //! The code returned from the authorization page via @[get_auth_url()]. //! //! @param async_cb //! If given an async request will be made and this function will be called //! when the request is finished. The first argument passed to the callback //! will be @expr{true@} or @expr{false@} depending on if the request was //! successfull or not. The second argument will be a string. If the request //! failed it will be an error message. If it succeeded it will be the result //! as a string encoded with @[predef::encode_value()]. //! //! @returns //! If @expr{OK@} a Pike encoded mapping (i.e it's a string) is returned //! which can be used to populate an @[Base] object at a later time. //! //! The mapping looks like //! @mapping //! @member string "access_token" //! @member int "expires" //! @member int "created" //! @member string "refresh_token" //! @member string "token_type" //! @endmapping //! //! Depending on the authorization service it might also contain more //! members. string request_access_token(string code, void|function(bool,string:void) async_cb) { return ::request_access_token(OAUTH_TOKEN_URI, code, async_cb); } //! Refreshes the access token, if a refresh token exists in the object //! //! @param async_cb //! If given an async request will be made and this function will be called //! when the request is finished. The first argument passed to the callback //! will be @expr{true@} or @expr{false@} depending on if the request was //! successfull or not. The second argument will be a string. If the request //! failed it will be an error message. If it succeeded it will be the result //! as a string encoded with @[predef::encode_value()]. string refresh_access_token(void|function(bool,string:void) async_cb) { return ::refresh_access_token(OAUTH_TOKEN_URI, async_cb); } }

pike.git/ lib/ modules/ Auth.pmod/ OAuth2.pmod > 5f58bdeecb41320455102b95b9180cba3c5d04f5 [Annotate]