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/_oidc_configuration_8cs_source.html
T

135 lines
19 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/Configuration/OidcConfiguration.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_08963d262fa9e27215dce7b7c6e97f1b.html">Configuration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">OidcConfiguration.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_oidc_configuration_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>Microsoft.IdentityModel.JsonWebTokens;</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_configuration.html">Tgstation.Server.Host.Configuration</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_configuration_1_1_oidc_configuration.html"> 10</a></span> <span class="keyword">public</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_configuration_1_1_oidc_configuration.html">OidcConfiguration</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_configuration_1_1_oidc_configuration.html#a5acf83f4f4c2e7745d8fca862beda4ff"> 15</a></span> <span class="keyword">private</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a5acf83f4f4c2e7745d8fca862beda4ff">DefaultGroupClaimName</a> = <span class="stringliteral">&quot;tgstation-server-group-id&quot;</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_configuration_1_1_oidc_configuration.html#ad5dd95f1ba70a58d90eddb87e92bfe0c"> 20</a></span> <span class="keyword">public</span> Uri? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#ad5dd95f1ba70a58d90eddb87e92bfe0c">Authority</a> { <span class="keyword">get</span>; <span class="keyword">set</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_configuration_1_1_oidc_configuration.html#a2176fc74a7620678f8bcdef9e5127a53"> 25</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_configuration_1_1_oidc_configuration.html#a2176fc74a7620678f8bcdef9e5127a53">ClientId</a> { <span class="keyword">get</span>; <span class="keyword">set</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_configuration_1_1_oidc_configuration.html#ac3c611887d8f6a32f8faeacf62ca6223"> 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_configuration_1_1_oidc_configuration.html#ac3c611887d8f6a32f8faeacf62ca6223">ClientSecret</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</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_configuration_1_1_oidc_configuration.html#a72d54a0bb9b391d98a34d88a0a022486"> 35</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_configuration_1_1_oidc_configuration.html#a72d54a0bb9b391d98a34d88a0a022486">FriendlyName</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</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_configuration_1_1_oidc_configuration.html#a327d1c227266c0b3d85791d4c1dc7f8f"> 40</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_configuration_1_1_oidc_configuration.html#a327d1c227266c0b3d85791d4c1dc7f8f">ReturnPath</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; } = <span class="stringliteral">&quot;/app&quot;</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#ae331bb8fde8877fe51ede24ab8cad43c"> 45</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_configuration_1_1_oidc_configuration.html#ae331bb8fde8877fe51ede24ab8cad43c">ThemeColour</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a73c988d899fab4eb4e4481d7d5710f0f"> 50</a></span> <span class="keyword">public</span> Uri? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a73c988d899fab4eb4e4481d7d5710f0f">ThemeIconUrl</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a34552345c1e24c9d3f9ba7bd0cdf61ca"> 55</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_configuration_1_1_oidc_configuration.html#a34552345c1e24c9d3f9ba7bd0cdf61ca">UsernameClaim</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; } = JwtRegisteredClaimNames.PreferredUsername;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a265a3524c38ea70cdd5013e7e5c96f99"> 60</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_configuration_1_1_oidc_configuration.html#a265a3524c38ea70cdd5013e7e5c96f99">GroupIdClaim</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; } = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a5acf83f4f4c2e7745d8fca862beda4ff">DefaultGroupClaimName</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> }</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html">Tgstation.Server.Host.Configuration.OidcConfiguration</a></div><div class="ttdoc">Configuration for an OpenID Connect provider.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00010">OidcConfiguration.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a2176fc74a7620678f8bcdef9e5127a53"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a2176fc74a7620678f8bcdef9e5127a53">Tgstation.Server.Host.Configuration.OidcConfiguration.ClientId</a></div><div class="ttdeci">string? ClientId</div><div class="ttdoc">The OIDC client ID.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00025">OidcConfiguration.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a265a3524c38ea70cdd5013e7e5c96f99"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a265a3524c38ea70cdd5013e7e5c96f99">Tgstation.Server.Host.Configuration.OidcConfiguration.GroupIdClaim</a></div><div class="ttdeci">string GroupIdClaim</div><div class="ttdoc">Claim name used to set user groups in OIDC strict mode.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00060">OidcConfiguration.cs:60</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a327d1c227266c0b3d85791d4c1dc7f8f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a327d1c227266c0b3d85791d4c1dc7f8f">Tgstation.Server.Host.Configuration.OidcConfiguration.ReturnPath</a></div><div class="ttdeci">string? ReturnPath</div><div class="ttdoc">The path to return to once OIDC authentication is complete. On success the &quot;code&quot; and &quot;state&quot; query s...</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00040">OidcConfiguration.cs:40</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a34552345c1e24c9d3f9ba7bd0cdf61ca"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a34552345c1e24c9d3f9ba7bd0cdf61ca">Tgstation.Server.Host.Configuration.OidcConfiguration.UsernameClaim</a></div><div class="ttdeci">string UsernameClaim</div><div class="ttdoc">The name of the claim used to set the user's name.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00055">OidcConfiguration.cs:55</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a5acf83f4f4c2e7745d8fca862beda4ff"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a5acf83f4f4c2e7745d8fca862beda4ff">Tgstation.Server.Host.Configuration.OidcConfiguration.DefaultGroupClaimName</a></div><div class="ttdeci">const string DefaultGroupClaimName</div><div class="ttdoc">The default value of GroupIdClaim.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00015">OidcConfiguration.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a72d54a0bb9b391d98a34d88a0a022486"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a72d54a0bb9b391d98a34d88a0a022486">Tgstation.Server.Host.Configuration.OidcConfiguration.FriendlyName</a></div><div class="ttdeci">string? FriendlyName</div><div class="ttdoc">The provider's name as it should be displayed to the user.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00035">OidcConfiguration.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_a73c988d899fab4eb4e4481d7d5710f0f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#a73c988d899fab4eb4e4481d7d5710f0f">Tgstation.Server.Host.Configuration.OidcConfiguration.ThemeIconUrl</a></div><div class="ttdeci">Uri? ThemeIconUrl</div><div class="ttdoc">Image URL that should be used to theme this OIDC provider.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00050">OidcConfiguration.cs:50</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_ac3c611887d8f6a32f8faeacf62ca6223"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#ac3c611887d8f6a32f8faeacf62ca6223">Tgstation.Server.Host.Configuration.OidcConfiguration.ClientSecret</a></div><div class="ttdeci">string? ClientSecret</div><div class="ttdoc">The OIDC client secret.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00030">OidcConfiguration.cs:30</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_ad5dd95f1ba70a58d90eddb87e92bfe0c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#ad5dd95f1ba70a58d90eddb87e92bfe0c">Tgstation.Server.Host.Configuration.OidcConfiguration.Authority</a></div><div class="ttdeci">Uri? Authority</div><div class="ttdoc">The Uri containing the .well-known endpoint for the provider.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00020">OidcConfiguration.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration_html_ae331bb8fde8877fe51ede24ab8cad43c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_oidc_configuration.html#ae331bb8fde8877fe51ede24ab8cad43c">Tgstation.Server.Host.Configuration.OidcConfiguration.ThemeColour</a></div><div class="ttdeci">string? ThemeColour</div><div class="ttdoc">Colour that should be used to theme this OIDC provider.</div><div class="ttdef"><b>Definition</b> <a href="_oidc_configuration_8cs_source.html#l00045">OidcConfiguration.cs:45</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><!-- 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