cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_git_hub_o_auth_validator_8cs_source.html
T

203 lines
36 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Security/OAuth/GitHubOAuthValidator.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_c5451d9d233744a5b09a29938f0cda9a.html">Security</a></li><li class="navelem"><a class="el" href="dir_204b1236065673831413cfa068ed9436.html">OAuth</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">GitHubOAuthValidator.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_git_hub_o_auth_validator_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Globalization;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>Microsoft.Extensions.Logging;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>Octokit;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Tgstation.Server.Host.Configuration</a>;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub.html">Tgstation.Server.Host.Utils.GitHub</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth.html">Tgstation.Server.Host.Security.OAuth</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html"> 19</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html">GitHubOAuthValidator</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_i_o_auth_validator.html">IOAuthValidator</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a4e17b40cd71087550bb3d49d65e2ebf9"> 22</a></span> <span class="keyword">public</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a49b1c1275c0d47d43360f8c7619ec901">OAuthProvider</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a4e17b40cd71087550bb3d49d65e2ebf9">Provider</a> =&gt; <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a49b1c1275c0d47d43360f8c7619ec901">OAuthProvider</a>.GitHub;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a060ec57be35f0b750277893643443707"> 25</a></span> <span class="keyword">public</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host.html#a71712cdd4f38be5482e1d08905c0c308">OAuthGatewayStatus</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a060ec57be35f0b750277893643443707">GatewayStatus</a> =&gt; oAuthConfiguration.Gateway ?? <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b"> 30</a></span> readonly <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html">IGitHubServiceFactory</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc"> 35</a></span> readonly ILogger&lt;GitHubOAuthValidator&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac"> 40</a></span> readonly <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration.html">OAuthConfiguration</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="}">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a1aac253342697e89cff3a35b05f051d3"> 48</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a1aac253342697e89cff3a35b05f051d3">GitHubOAuthValidator</a>(</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html">IGitHubServiceFactory</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a>,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> ILogger&lt;GitHubOAuthValidator&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration.html">OAuthConfiguration</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>)</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> this.gitHubServiceFactory = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a>));</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> this.logger = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>));</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> this.oAuthConfiguration = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>));</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="}">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#ab04d9f6cff4beafd46bfc8fa84627cea"> 59</a></span> <span class="keyword">public</span> async ValueTask&lt;(<span class="keywordtype">string</span>? UserID, <span class="keywordtype">string</span> AccessCode)?&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#ab04d9f6cff4beafd46bfc8fa84627cea">ValidateResponseCode</a>(<span class="keywordtype">string</span> code, <span class="keywordtype">bool</span> requireUserID, CancellationToken cancellationToken)</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> ArgumentNullException.ThrowIfNull(code);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">try</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> {</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>.LogTrace(<span class="stringliteral">&quot;Validating response code...&quot;</span>);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> var gitHubService = await <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html#a93de0a6eeb420eec2ecaa935ebabc7b9">CreateService</a>(cancellationToken);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> var token = await gitHubService.CreateOAuthAccessToken(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>, code, cancellationToken);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">if</span> (token == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> <span class="keyword">null</span>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">if</span> (!requireUserID)</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">return</span> (<span class="keyword">null</span>, AccessCode: token);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> var authenticatedClient = await <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">gitHubServiceFactory</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html#a93de0a6eeb420eec2ecaa935ebabc7b9">CreateService</a>(token, cancellationToken);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>.LogTrace(<span class="stringliteral">&quot;Getting user details...&quot;</span>);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> var userId = await authenticatedClient.GetCurrentUserId(cancellationToken);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordflow">return</span> (userId.ToString(CultureInfo.InvariantCulture), AccessCode: token);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">catch</span> (RateLimitExceededException)</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">throw</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">catch</span> (ApiException ex)</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> {</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">logger</a>.LogWarning(ex, <span class="stringliteral">&quot;API error while completing OAuth handshake!&quot;</span>);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">return</span> <span class="keyword">null</span>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> }</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="}">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#abc12c5a99036b95a8a58c35660798146"> 94</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_o_auth_provider_info.html">OAuthProviderInfo</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#abc12c5a99036b95a8a58c35660798146">GetProviderInfo</a>()</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> =&gt; <span class="keyword">new</span>()</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> ClientId = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base.html#a8523441e7fcf0bd35a12ee828881e6be">ClientId</a>,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> RedirectUri = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">oAuthConfiguration</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration.html#a7dc852a81f4df661f158157a6c3b512a">RedirectUrl</a>,</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> GatewayOnly = <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a060ec57be35f0b750277893643443707">GatewayStatus</a>.ToBoolean(),</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> };</div>
</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> }</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_o_auth_provider_info_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_o_auth_provider_info.html">Tgstation.Server.Api.Models.OAuthProviderInfo</a></div><div class="ttdoc">Public information about a given OAuthProvider.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_provider_info_8cs_source.html#l00008">OAuthProviderInfo.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base_html_a8523441e7fcf0bd35a12ee828881e6be"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base.html#a8523441e7fcf0bd35a12ee828881e6be">Tgstation.Server.Host.Configuration.OAuthConfigurationBase.ClientId</a></div><div class="ttdeci">string? ClientId</div><div class="ttdoc">The client ID.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_configuration_base_8cs_source.html#l00013">OAuthConfigurationBase.cs:13</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration.html">Tgstation.Server.Host.Configuration.OAuthConfiguration</a></div><div class="ttdoc">OAuth configuration options.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_configuration_8cs_source.html#l00008">OAuthConfiguration.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_html_a7dc852a81f4df661f158157a6c3b512a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration.html#a7dc852a81f4df661f158157a6c3b512a">Tgstation.Server.Host.Configuration.OAuthConfiguration.RedirectUrl</a></div><div class="ttdeci">Uri? RedirectUrl</div><div class="ttdoc">The authentication server URL. Not used by all providers.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_configuration_8cs_source.html#l00018">OAuthConfiguration.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator</a></div><div class="ttdoc">IOAuthValidator for GitHub.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00019">GitHubOAuthValidator.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_a060ec57be35f0b750277893643443707"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a060ec57be35f0b750277893643443707">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.GatewayStatus</a></div><div class="ttdeci">OAuthGatewayStatus GatewayStatus</div><div class="ttdoc">The OAuthGatewayStatus for the IOAuthValidator.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00025">GitHubOAuthValidator.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_a1aac253342697e89cff3a35b05f051d3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a1aac253342697e89cff3a35b05f051d3">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.GitHubOAuthValidator</a></div><div class="ttdeci">GitHubOAuthValidator(IGitHubServiceFactory gitHubServiceFactory, ILogger&lt; GitHubOAuthValidator &gt; logger, OAuthConfiguration oAuthConfiguration)</div><div class="ttdoc">Initializes a new instance of the GitHubOAuthValidator class.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00048">GitHubOAuthValidator.cs:48</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_a431a40f08a97d7a26f55c74ae31f2bbc"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a431a40f08a97d7a26f55c74ae31f2bbc">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.logger</a></div><div class="ttdeci">readonly ILogger&lt; GitHubOAuthValidator &gt; logger</div><div class="ttdoc">The ILogger for the GitHubOAuthValidator.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00035">GitHubOAuthValidator.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_a4e17b40cd71087550bb3d49d65e2ebf9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a4e17b40cd71087550bb3d49d65e2ebf9">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.Provider</a></div><div class="ttdeci">OAuthProvider Provider</div><div class="ttdoc">The OAuthProvider this validator is for.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00022">GitHubOAuthValidator.cs:22</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_a5ad102bb2c945c31bb11328bc4d7d73b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#a5ad102bb2c945c31bb11328bc4d7d73b">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.gitHubServiceFactory</a></div><div class="ttdeci">readonly IGitHubServiceFactory gitHubServiceFactory</div><div class="ttdoc">The IGitHubServiceFactory for the GitHubOAuthValidator.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00030">GitHubOAuthValidator.cs:30</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_aadd4ea2984d8fbd718b1814a445c58ac"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#aadd4ea2984d8fbd718b1814a445c58ac">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.oAuthConfiguration</a></div><div class="ttdeci">readonly OAuthConfiguration oAuthConfiguration</div><div class="ttdoc">The OAuthConfiguration for the GitHubOAuthValidator.</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00040">GitHubOAuthValidator.cs:40</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_ab04d9f6cff4beafd46bfc8fa84627cea"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#ab04d9f6cff4beafd46bfc8fa84627cea">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.ValidateResponseCode</a></div><div class="ttdeci">async ValueTask&lt;(string? UserID, string AccessCode)?&gt; ValidateResponseCode(string code, bool requireUserID, CancellationToken cancellationToken)</div><div class="ttdoc">Validate a given OAuth response code .A ValueTask&lt;TResult&gt; resulting in null if authentication failed...</div><div class="ttdef"><b>Definition</b> <a href="_git_hub_o_auth_validator_8cs_source.html#l00059">GitHubOAuthValidator.cs:59</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator_html_abc12c5a99036b95a8a58c35660798146"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_git_hub_o_auth_validator.html#abc12c5a99036b95a8a58c35660798146">Tgstation.Server.Host.Security.OAuth.GitHubOAuthValidator.GetProviderInfo</a></div><div class="ttdeci">OAuthProviderInfo GetProviderInfo()</div><div class="ttdoc">Gets the OAuthProvider of validator.The client ID of the validator on success, null on failure.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_i_o_auth_validator_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_i_o_auth_validator.html">Tgstation.Server.Host.Security.OAuth.IOAuthValidator</a></div><div class="ttdoc">Validates OAuth responses for a given Provider.</div><div class="ttdef"><b>Definition</b> <a href="_i_o_auth_validator_8cs_source.html#l00011">IOAuthValidator.cs:12</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html">Tgstation.Server.Host.Utils.GitHub.IGitHubServiceFactory</a></div><div class="ttdoc">Factory for IGitHubServices.</div><div class="ttdef"><b>Definition</b> <a href="_i_git_hub_service_factory_8cs_source.html#l00009">IGitHubServiceFactory.cs:10</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory_html_a93de0a6eeb420eec2ecaa935ebabc7b9"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_factory.html#a93de0a6eeb420eec2ecaa935ebabc7b9">Tgstation.Server.Host.Utils.GitHub.IGitHubServiceFactory.CreateService</a></div><div class="ttdeci">ValueTask&lt; IGitHubService &gt; CreateService(CancellationToken cancellationToken)</div><div class="ttdoc">Create a IGitHubService.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html_a49b1c1275c0d47d43360f8c7619ec901"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a49b1c1275c0d47d43360f8c7619ec901">Tgstation.Server.Api.Models.OAuthProvider</a></div><div class="ttdeci">OAuthProvider</div><div class="ttdoc">List of OAuth2.0 providers supported by TGS that do not support OIDC.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_provider_8cs_source.html#l00012">OAuthProvider.cs:13</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_configuration_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Tgstation.Server.Host.Configuration</a></div><div class="ttdef"><b>Definition</b> <a href="_control_panel_configuration_8cs_source.html#l00003">ControlPanelConfiguration.cs:4</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_application_builder_extensions_8cs_source.html#l00021">ApplicationBuilderExtensions.cs:22</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth.html">Tgstation.Server.Host.Security.OAuth</a></div><div class="ttdef"><b>Definition</b> <a href="_discord_o_auth_validator_8cs_source.html#l00009">DiscordOAuthValidator.cs:10</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub.html">Tgstation.Server.Host.Utils.GitHub</a></div><div class="ttdef"><b>Definition</b> <a href="_git_hub_client_factory_8cs_source.html#l00022">GitHubClientFactory.cs:23</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_html_a71712cdd4f38be5482e1d08905c0c308"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host.html#a71712cdd4f38be5482e1d08905c0c308">Tgstation.Server.Host.OAuthGatewayStatus</a></div><div class="ttdeci">OAuthGatewayStatus</div><div class="ttdoc">Status of the OAuth gateway for a provider.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_gateway_status_8cs_source.html#l00006">OAuthGatewayStatus.cs:7</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink