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
bc7c0b7d535bf4249e24257c97a843f752f96fe1
tgstation-server/_o_auth_token_request_8cs_source.html
T

134 lines
17 KiB
HTML
Raw 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/OAuthTokenRequest.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">OAuthTokenRequest.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_o_auth_token_request_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> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</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="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</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="l00006" name="l00006"></a><span class="lineno"> 6</span>{</div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></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_o_auth_token_request.html"> 10</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_o_auth_token_request.html">OAuthTokenRequest</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base.html">OAuthConfigurationBase</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> {</div>
<div class="line"><a id="l00015" name="l00015"></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_o_auth_token_request.html#a6982ea4e58e777e6b410b220df19f31b"> 15</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a6982ea4e58e777e6b410b220df19f31b">Code</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00020" name="l00020"></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_o_auth_token_request.html#ab18e7c977a802e87f7d69937f43b18ac"> 20</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#ab18e7c977a802e87f7d69937f43b18ac">Scope</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</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_o_auth_token_request.html#a8b152d6dffc1624e3c38b2c7113301e5"> 25</a></span> <span class="keyword">public</span> Uri? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a8b152d6dffc1624e3c38b2c7113301e5">RedirectUri</a> { <span class="keyword">get</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_o_auth_token_request.html#a73f0d58a2b16cc2d67dee3cc07b1872c"> 30</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a73f0d58a2b16cc2d67dee3cc07b1872c">GrantType</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></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_o_auth_token_request.html#a5495dedb43c6958837d25bdbfdad4a70"> 38</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_o_auth_token_request.html#a5495dedb43c6958837d25bdbfdad4a70">OAuthTokenRequest</a>(<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> oAuthConfiguration, <span class="keywordtype">string</span> code, <span class="keywordtype">string</span> scope)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> : base(oAuthConfiguration)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a6982ea4e58e777e6b410b220df19f31b">Code</a> = code ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(code));</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#ab18e7c977a802e87f7d69937f43b18ac">Scope</a> = scope ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(scope));</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a8b152d6dffc1624e3c38b2c7113301e5">RedirectUri</a> = oAuthConfiguration.<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="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a73f0d58a2b16cc2d67dee3cc07b1872c">GrantType</a> = <span class="stringliteral">&quot;authorization_code&quot;</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_o_auth_configuration_base.html">Tgstation.Server.Host.Configuration.OAuthConfigurationBase</a></div><div class="ttdoc">Base OAuth options.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_configuration_base_8cs_source.html#l00008">OAuthConfigurationBase.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"><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_o_auth_token_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest</a></div><div class="ttdoc">Generic OAuth token request.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00010">OAuthTokenRequest.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request_html_a5495dedb43c6958837d25bdbfdad4a70"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a5495dedb43c6958837d25bdbfdad4a70">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest.OAuthTokenRequest</a></div><div class="ttdeci">OAuthTokenRequest(OAuthConfiguration oAuthConfiguration, string code, string scope)</div><div class="ttdoc">Initializes a new instance of the OAuthTokenRequest class.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00038">OAuthTokenRequest.cs:38</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request_html_a6982ea4e58e777e6b410b220df19f31b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a6982ea4e58e777e6b410b220df19f31b">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest.Code</a></div><div class="ttdeci">string Code</div><div class="ttdoc">The OAuth code received from the browser.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00015">OAuthTokenRequest.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request_html_a73f0d58a2b16cc2d67dee3cc07b1872c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a73f0d58a2b16cc2d67dee3cc07b1872c">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest.GrantType</a></div><div class="ttdeci">string GrantType</div><div class="ttdoc">The OAuth grant type.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00030">OAuthTokenRequest.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_o_auth_token_request_html_a8b152d6dffc1624e3c38b2c7113301e5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#a8b152d6dffc1624e3c38b2c7113301e5">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest.RedirectUri</a></div><div class="ttdeci">Uri? RedirectUri</div><div class="ttdoc">The OAuth redirect URI.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00025">OAuthTokenRequest.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_o_auth_token_request_html_ab18e7c977a802e87f7d69937f43b18ac"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_o_auth_1_1_o_auth_token_request.html#ab18e7c977a802e87f7d69937f43b18ac">Tgstation.Server.Host.Security.OAuth.OAuthTokenRequest.Scope</a></div><div class="ttdeci">string Scope</div><div class="ttdoc">The scopes being requested.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_token_request_8cs_source.html#l00020">OAuthTokenRequest.cs:20</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_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><!-- 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