From 71e29f99acc6f85154d0ed574ed8e68bfcaec329 Mon Sep 17 00:00:00 2001 From: vnugent Date: Sun, 8 Jan 2023 18:41:00 -0500 Subject: Net.Rest.Client addition --- lib/Net.Rest.Client/LICENSE.txt | 346 +++++++++++++++++++++ lib/Net.Rest.Client/README.md | 1 + lib/Net.Rest.Client/src/ClientContract.cs | 60 ++++ lib/Net.Rest.Client/src/ClientPool.cs | 71 +++++ lib/Net.Rest.Client/src/OAuth2/Credential.cs | 78 +++++ .../src/OAuth2/O2ErrorResponseMessage.cs | 80 +++++ .../src/OAuth2/OAuth2AuthenticationException.cs | 77 +++++ .../src/OAuth2/OAuth2Authenticator.cs | 137 ++++++++ .../src/VNLib.Net.Rest.Client.csproj | 44 +++ 9 files changed, 894 insertions(+) create mode 100644 lib/Net.Rest.Client/LICENSE.txt create mode 100644 lib/Net.Rest.Client/README.md create mode 100644 lib/Net.Rest.Client/src/ClientContract.cs create mode 100644 lib/Net.Rest.Client/src/ClientPool.cs create mode 100644 lib/Net.Rest.Client/src/OAuth2/Credential.cs create mode 100644 lib/Net.Rest.Client/src/OAuth2/O2ErrorResponseMessage.cs create mode 100644 lib/Net.Rest.Client/src/OAuth2/OAuth2AuthenticationException.cs create mode 100644 lib/Net.Rest.Client/src/OAuth2/OAuth2Authenticator.cs create mode 100644 lib/Net.Rest.Client/src/VNLib.Net.Rest.Client.csproj (limited to 'lib/Net.Rest.Client') diff --git a/lib/Net.Rest.Client/LICENSE.txt b/lib/Net.Rest.Client/LICENSE.txt new file mode 100644 index 0000000..2848520 --- /dev/null +++ b/lib/Net.Rest.Client/LICENSE.txt @@ -0,0 +1,346 @@ +The software in this repository is licensed under the GNU GPL version 2.0 (or any later version). + +SPDX-License-Identifier: GPL-2.0-or-later + +License-Text: + +GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + VNLib.Hashing.Portable is a compact .NET managed cryptographic operation + utilities library. + Copyright (C) 2022 Vaughn Nugent + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. \ No newline at end of file diff --git a/lib/Net.Rest.Client/README.md b/lib/Net.Rest.Client/README.md new file mode 100644 index 0000000..199f6e5 --- /dev/null +++ b/lib/Net.Rest.Client/README.md @@ -0,0 +1 @@ +# VNLib.Net.Rest.Client \ No newline at end of file diff --git a/lib/Net.Rest.Client/src/ClientContract.cs b/lib/Net.Rest.Client/src/ClientContract.cs new file mode 100644 index 0000000..0c61f8c --- /dev/null +++ b/lib/Net.Rest.Client/src/ClientContract.cs @@ -0,0 +1,60 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: ClientContract.cs +* +* ClientContract.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using RestSharp; +using VNLib.Utils.Memory.Caching; +using VNLib.Utils.Resources; + +namespace VNLib.Net.Rest.Client +{ + /// + /// Represents a RestClient least contract. When disposed, + /// releases it for use by other waiters + /// + public class ClientContract : OpenResourceHandle + { + private readonly RestClient _client; + private readonly ObjectRental _pool; + + internal ClientContract(RestClient client, ObjectRental pool) + { + _client = client; + _pool = pool; + } + /// + public override RestClient Resource + { + get + { + Check(); + return _client; + } + } + /// + protected override void Free() + { + _pool.Return(_client); + } + } +} diff --git a/lib/Net.Rest.Client/src/ClientPool.cs b/lib/Net.Rest.Client/src/ClientPool.cs new file mode 100644 index 0000000..7d3bbd0 --- /dev/null +++ b/lib/Net.Rest.Client/src/ClientPool.cs @@ -0,0 +1,71 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: ClientPool.cs +* +* ClientPool.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +using RestSharp; +using RestSharp.Authenticators; + +using VNLib.Utils.Memory.Caching; + +#nullable enable + +namespace VNLib.Net.Rest.Client +{ + /// + /// Maintains a pool of lazy loaded instances to allow for concurrent client usage + /// + public class RestClientPool : ObjectRental + { + /// + /// Creates a new instance and creates the specified + /// number of clients with the same number of concurrency. + /// + /// The maximum number of clients to create and authenticate, should be the same as the number of maximum allowed tokens + /// A used to initialze the pool of clients + /// An optional authenticator for clients to use + /// An optional client initialzation callback + public RestClientPool(int maxClients, RestClientOptions options, Action? initCb = null, IAuthenticator? authenticator = null) + : base(() => + { + RestClient client = new(options); + //Add optional authenticator + if (authenticator != null) + { + client.UseAuthenticator(authenticator); + } + //Invoke init callback + initCb?.Invoke(client); + return client; + }, null, null, maxClients) + { + } + + /// + /// Obtains a new for a reused, or new, instance + /// + /// The contract that manages the client + public ClientContract Lease() => new(base.Rent(), this); + } +} diff --git a/lib/Net.Rest.Client/src/OAuth2/Credential.cs b/lib/Net.Rest.Client/src/OAuth2/Credential.cs new file mode 100644 index 0000000..3fd5da6 --- /dev/null +++ b/lib/Net.Rest.Client/src/OAuth2/Credential.cs @@ -0,0 +1,78 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: Credential.cs +* +* Credential.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +using VNLib.Utils.Memory; + +namespace VNLib.Net.Rest.Client.OAuth2 +{ + /// + /// Creates a disposeable "protected" credential object. + /// + /// + /// Properties used after the instance has been disposed are + /// undefined + /// + public class Credential : PrivateStringManager + { + /// + /// The credential username parameter + /// + public string UserName => this[0]; + /// + /// The credential's password + /// + public string Password => this[1]; + + private Credential(string uname, string pass) : base(2) + { + this[0] = uname; + this[1] = pass; + } + + /// + /// Creates a new protected + /// that owns the memory to the supplied strings + /// + /// The username string to consume + /// The password string to consume + /// A new protected credential object + public static Credential CreateUnsafe(in string username, in string password) + { + return new Credential(username, password); + } + /// + /// Creates a new "safe" by copying + /// the values of the supplied credential properites + /// + /// The username value to copy + /// The password value to copy + /// A new protected credential object + public static Credential Create(ReadOnlySpan username, ReadOnlySpan password) + { + return new Credential(username.ToString(), password.ToString()); + } + } +} diff --git a/lib/Net.Rest.Client/src/OAuth2/O2ErrorResponseMessage.cs b/lib/Net.Rest.Client/src/OAuth2/O2ErrorResponseMessage.cs new file mode 100644 index 0000000..151c575 --- /dev/null +++ b/lib/Net.Rest.Client/src/OAuth2/O2ErrorResponseMessage.cs @@ -0,0 +1,80 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: O2ErrorResponseMessage.cs +* +* O2ErrorResponseMessage.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace VNLib.Net.Rest.Client.OAuth2 +{ + /// + /// An OAuth2 standard error message + /// + public class O2ErrorResponseMessage + { + /// + /// The OAuth2 error code + /// + [JsonPropertyName("error_code")] + public string ErrorCode { get; set; } + + /// + /// The OAuth2 human readable error description + /// + [JsonPropertyName("error_description")] + public string ErrorDescription { get; set; } + /// + /// Initializes a new + /// + public O2ErrorResponseMessage() + {} + /// + /// Initializes a new + /// + /// The OAuth2 error code + /// The OAuth2 error description + public O2ErrorResponseMessage(string code, string description) + { + this.ErrorCode = code; + ErrorDescription = description; + } + + /// + /// Initializes a new instance + /// from a error element + /// + /// An error element that represens the error + public O2ErrorResponseMessage(ref JsonElement el) + { + if(el.TryGetProperty("error_code", out JsonElement code)) + { + this.ErrorCode = code.GetString(); + } + if (el.TryGetProperty("error_code", out JsonElement description)) + { + this.ErrorDescription = description.GetString(); + } + } + } +} diff --git a/lib/Net.Rest.Client/src/OAuth2/OAuth2AuthenticationException.cs b/lib/Net.Rest.Client/src/OAuth2/OAuth2AuthenticationException.cs new file mode 100644 index 0000000..7176093 --- /dev/null +++ b/lib/Net.Rest.Client/src/OAuth2/OAuth2AuthenticationException.cs @@ -0,0 +1,77 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: OAuth2AuthenticationException.cs +* +* OAuth2AuthenticationException.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Net; +using System.Security.Authentication; + +using RestSharp; + +namespace VNLib.Net.Rest.Client.OAuth2 +{ + /// + /// Raised when a token request made to the authorization endpoint + /// fails. Inner exceptions may be set if the response succeeds but + /// returned invalid data + /// + public class OAuth2AuthenticationException : AuthenticationException + { + /// + /// The status code returned from the request + /// + public HttpStatusCode StatusCode => ErrorResponse?.StatusCode ?? 0; + /// + /// The string representation of the response that was received by the token request + /// + public RestResponse ErrorResponse { get; } + /// + public OAuth2AuthenticationException() + { } + /// + public OAuth2AuthenticationException(string message) : base(message) + { } + /// + public OAuth2AuthenticationException(string message, Exception innerException) : base(message, innerException) + { } + /// + /// Initializes a new with the + /// specified server response + /// + /// The response containing the error result + public OAuth2AuthenticationException(RestResponse response) : base() + { + ErrorResponse = response; + } + /// + /// Initializes a new with the + /// specified server response + /// + /// The response containing the error result + /// An inner excepion that caused the authentication to fail + public OAuth2AuthenticationException(RestResponse response, Exception innerException) : base(null, innerException) + { + ErrorResponse = response; + } + } +} diff --git a/lib/Net.Rest.Client/src/OAuth2/OAuth2Authenticator.cs b/lib/Net.Rest.Client/src/OAuth2/OAuth2Authenticator.cs new file mode 100644 index 0000000..b978404 --- /dev/null +++ b/lib/Net.Rest.Client/src/OAuth2/OAuth2Authenticator.cs @@ -0,0 +1,137 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Rest.Client +* File: OAuth2Authenticator.cs +* +* OAuth2Authenticator.cs is part of VNLib.Net.Rest.Client which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Rest.Client is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Net.Rest.Client is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Net.Rest.Client. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Net; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +using RestSharp; +using RestSharp.Authenticators; + +using VNLib.Utils; +using VNLib.Utils.Extensions; + +#nullable enable + +namespace VNLib.Net.Rest.Client.OAuth2 +{ + /// + /// A self-contained OAuth2 RestSharp authenticator. Contains resources + /// that should be disposed, when no longer in use. Represents a single + /// session on the remote server + /// + public class OAuth2Authenticator : VnDisposeable, IAuthenticator + { + private string? AccessToken; + private DateTime Expires; + + private uint _counter; + + private readonly RestClient _client; + private readonly Func CredFunc; + private readonly string TokenAuthPath; + private readonly SemaphoreSlim _tokenLock; + + /// + /// Initializes a new to be used for + /// authorizing requests to a remote server + /// + /// The RestClient options for the client used to authenticate with the OAuth2 server + /// The credential factory function + /// The path within the remote OAuth2 server to authenticate against + public OAuth2Authenticator(RestClientOptions clientOps, Func credFunc, string tokenPath) + { + //Default to expired + Expires = DateTime.MinValue; + _client = new(clientOps); + CredFunc = credFunc; + TokenAuthPath = tokenPath; + _tokenLock = new(1, 1); + } + + async ValueTask IAuthenticator.Authenticate(RestClient client, RestRequest request) + { + //Wait for access to the token incase another thread is updating it + using SemSlimReleaser releaser = await _tokenLock.GetReleaserAsync(CancellationToken.None); + //Check expiration + if (Expires < DateTime.UtcNow) + { + //We need to refresh the token + await RefreshTokenAsync(); + } + //Add bearer token to the request + request.AddOrUpdateHeader("Authorization", AccessToken!); + //Inc counter + _counter++; + } + + private async Task RefreshTokenAsync() + { + using Credential creds = CredFunc(); + //Build request to the authentication endpoint + RestRequest tokenRequest = new(TokenAuthPath, Method.Post); + //Setup grant-type paramter + tokenRequest.AddParameter("grant_type", "client_credentials", ParameterType.GetOrPost); + //Add client id + tokenRequest.AddParameter("client_id", creds.UserName, ParameterType.GetOrPost); + //Add secret + tokenRequest.AddParameter("client_secret", creds.Password, ParameterType.GetOrPost); + //exec get token + RestResponse tokenResponse = await _client.ExecuteAsync(tokenRequest); + if (!tokenResponse.IsSuccessful) + { + throw new OAuth2AuthenticationException(tokenResponse, tokenResponse.ErrorException); + } + try + { + //Get a json doc for the response data + using JsonDocument response = JsonDocument.Parse(tokenResponse.RawBytes); + //Get expiration + int expiresSec = response.RootElement.GetProperty("expires_in").GetInt32(); + //get access token + string? accessToken = response.RootElement.GetProperty("access_token").GetString(); + string? tokenType = response.RootElement.GetProperty("token_type").GetString(); + + //Store token variables, expire a few minutes before the server to allow for time disparity + Expires = DateTime.UtcNow.AddSeconds(expiresSec).Subtract(TimeSpan.FromMinutes(2)); + //compile auth header value + AccessToken = $"{tokenType} {accessToken}"; + //Reset counter + _counter = 0; + } + catch (Exception ex) + { + throw new OAuth2AuthenticationException(tokenResponse, ex); + } + } + + protected override void Free() + { + _tokenLock.Dispose(); + _client.Dispose(); + } + } +} diff --git a/lib/Net.Rest.Client/src/VNLib.Net.Rest.Client.csproj b/lib/Net.Rest.Client/src/VNLib.Net.Rest.Client.csproj new file mode 100644 index 0000000..1324192 --- /dev/null +++ b/lib/Net.Rest.Client/src/VNLib.Net.Rest.Client.csproj @@ -0,0 +1,44 @@ + + + + net6.0 + Copyright © 2022 Vaughn Nugent + Vaughn Nugent + 1.0.1.1 + An Oauth2 rest client connection pool for OAuth2 authenticated services + https://www.vaughnnugent.com/resources + VNLib.Net.Rest.Client + VNLib.Net.Rest.Client + True + latest-all + + + + False + + + + False + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + + + + + + + + + -- cgit