mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-25 05:56:58 +01:00
247 lines
39 KiB
HTML
247 lines
39 KiB
HTML
<!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/TokenFactory.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"> 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&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&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&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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">TokenFactory.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_token_factory_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.Collections.Generic;</div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Diagnostics.CodeAnalysis;</div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Globalization;</div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>System.IdentityModel.Tokens.Jwt;</div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>System.Linq;</div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>System.Security.Claims;</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>Microsoft.Extensions.Options;</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">using </span>Microsoft.IdentityModel.Tokens;</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </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_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a>;</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</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="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a>;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_system.html">Tgstation.Server.Host.System</a>;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
|
|
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
|
|
<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_token_factory.html"> 20</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_token_factory.html">TokenFactory</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory.html">ITokenFactory</a></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8"> 23</a></span> <span class="keyword">public</span> TokenValidationParameters <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8">ValidationParameters</a> { <span class="keyword">get</span>; }</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="foldopen" id="foldopen00026" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a480a3c7db42012b12fc4f3c3878f3693"> 26</a></span> <span class="keyword">public</span> ReadOnlySpan<byte> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a480a3c7db42012b12fc4f3c3878f3693">SigningKeyBytes</a></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">get</span> => <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a>.Key;</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> [MemberNotNull(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a>))]</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> [MemberNotNull(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#af0b547cfa6862fc9758da04ef95d0800">tokenHeader</a>))]</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">set</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a> = <span class="keyword">new</span> SymmetricSecurityKey(value.ToArray());</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#af0b547cfa6862fc9758da04ef95d0800">tokenHeader</a> = <span class="keyword">new</span> JwtHeader(</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">new</span> SigningCredentials(</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a>,</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> SecurityAlgorithms.HmacSha256));</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28"> 44</a></span> readonly IOptions<SecurityConfiguration> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a726228c10e81f681ddcd34431388b595"> 49</a></span> readonly JwtSecurityTokenHandler <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a726228c10e81f681ddcd34431388b595">tokenHandler</a>;</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf"> 54</a></span> SymmetricSecurityKey <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a>;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<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_token_factory.html#af0b547cfa6862fc9758da04ef95d0800"> 59</a></span> JwtHeader <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#af0b547cfa6862fc9758da04ef95d0800">tokenHeader</a>;</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="foldopen" id="foldopen00067" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#abfd5781e4ec94de4df000c2af5e67e76"> 67</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_token_factory.html#abfd5781e4ec94de4df000c2af5e67e76">TokenFactory</a>(</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite.html">ICryptographySuite</a> cryptographySuite,</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html">IAssemblyInformationProvider</a> assemblyInformationProvider,</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> IOptions<SecurityConfiguration> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>)</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> ArgumentNullException.ThrowIfNull(cryptographySuite);</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> ArgumentNullException.ThrowIfNull(assemblyInformationProvider);</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> this.securityConfigurationOptions = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</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_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>));</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_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a480a3c7db42012b12fc4f3c3878f3693">SigningKeyBytes</a> = <span class="keywordtype">string</span>.IsNullOrWhiteSpace(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.CustomTokenSigningKeyBase64)</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> ? cryptographySuite.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite.html#af462ac6cb18181f237f934f06207bc71">GetSecureBytes</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.TokenSigningKeyByteCount)</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> : Convert.FromBase64String(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.CustomTokenSigningKeyBase64);</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8">ValidationParameters</a> = <span class="keyword">new</span> TokenValidationParameters</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> {</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> ValidateIssuerSigningKey = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> IssuerSigningKeyResolver = (_, _, _, _) => Enumerable.Repeat(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">signingKey</a>, 1),</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> ValidateIssuer = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> ValidIssuer = assemblyInformationProvider.<a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html#a681c879b4ff73db055cd6fd39cb590b7">AssemblyName</a>.Name,</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> ValidateLifetime = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> ValidateAudience = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> ValidAudience = typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html">TokenResponse</a>).Assembly.GetName().Name,</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> ClockSkew = TimeSpan.FromMinutes(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.TokenClockSkewMinutes),</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> RequireSignedTokens = <span class="keyword">true</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> RequireExpirationTime = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> };</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a726228c10e81f681ddcd34431388b595">tokenHandler</a> = <span class="keyword">new</span> JwtSecurityTokenHandler();</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="foldopen" id="foldopen00104" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#abcab65ec88a61fde94c043f5c3a66753"> 104</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#abcab65ec88a61fde94c043f5c3a66753">CreateToken</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html">User</a> user, <span class="keywordtype">bool</span> serviceLogin)</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> {</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> ArgumentNullException.ThrowIfNull(user);</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> var uid = user.Require(x => x.Id);</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> var now = DateTimeOffset.UtcNow;</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> var nowUnix = now.ToUnixTimeSeconds();</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// this prevents validation conflicts down the line</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// tldr we can (theoretically) receive a token the same second after we generate it</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// since unix time rounds down, it looks like it came from before the user changed their password</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// this happens occasionally in unit tests</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="comment">// just delay a second so we can force a round up</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> var userLastPassworUpdateUnix = user.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html#abd891143624157c8f48bd166cc88ab26">LastPasswordUpdate</a>?.ToUnixTimeSeconds();</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> DateTimeOffset notBefore;</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordflow">if</span> (nowUnix == userLastPassworUpdateUnix)</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> notBefore = now.AddSeconds(1);</div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">else</span></div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> notBefore = now;</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> var expiry = now.AddMinutes(serviceLogin</div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> ? <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.OAuthTokenExpiryMinutes</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> : <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">securityConfigurationOptions</a>.Value.TokenExpiryMinutes);</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> var securityToken = <span class="keyword">new</span> JwtSecurityToken(</div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#af0b547cfa6862fc9758da04ef95d0800">tokenHeader</a>,</div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">new</span> JwtPayload(</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8">ValidationParameters</a>.ValidIssuer,</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8">ValidationParameters</a>.ValidAudience,</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> Enumerable.Empty<Claim>(),</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">new</span> Dictionary<string, object></div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> {</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> { JwtRegisteredClaimNames.Sub, uid.ToString(CultureInfo.InvariantCulture) },</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> },</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> notBefore.UtcDateTime,</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> expiry.UtcDateTime,</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> now.UtcDateTime));</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> var tokenResponse = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a726228c10e81f681ddcd34431388b595">tokenHandler</a>.WriteToken(securityToken);</div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="keywordflow">return</span> tokenResponse;</div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>}</div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html">Tgstation.Server.Api.Models.Response.TokenResponse</a></div><div class="ttdoc">Represents a JWT returned by the API.</div><div class="ttdef"><b>Definition</b> <a href="_token_response_8cs_source.html#l00008">TokenResponse.cs:9</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html">Tgstation.Server.Host.Models.User</a></div><div class="ttdef"><b>Definition</b> <a href="_models_2_user_8cs_source.html#l00013">User.cs:17</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_html_abd891143624157c8f48bd166cc88ab26"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html#abd891143624157c8f48bd166cc88ab26">Tgstation.Server.Host.Models.User.LastPasswordUpdate</a></div><div class="ttdeci">DateTimeOffset? LastPasswordUpdate</div><div class="ttdoc">When PasswordHash was last changed.</div><div class="ttdef"><b>Definition</b> <a href="_models_2_user_8cs_source.html#l00063">User.cs:63</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html">Tgstation.Server.Host.Security.TokenFactory</a></div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00020">TokenFactory.cs:21</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_a0c69dc398230d3309597c476fe0bcaaf"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a0c69dc398230d3309597c476fe0bcaaf">Tgstation.Server.Host.Security.TokenFactory.signingKey</a></div><div class="ttdeci">SymmetricSecurityKey signingKey</div><div class="ttdoc">Backing field for SigningKeyBytes.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00054">TokenFactory.cs:54</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_a1fe6c5c282b5db5a2a61a5417e634ed8"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a1fe6c5c282b5db5a2a61a5417e634ed8">Tgstation.Server.Host.Security.TokenFactory.ValidationParameters</a></div><div class="ttdeci">TokenValidationParameters ValidationParameters</div><div class="ttdoc">The TokenValidationParameters for the ITokenFactory.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00023">TokenFactory.cs:23</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_a480a3c7db42012b12fc4f3c3878f3693"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a480a3c7db42012b12fc4f3c3878f3693">Tgstation.Server.Host.Security.TokenFactory.SigningKeyBytes</a></div><div class="ttdeci">ReadOnlySpan< byte > SigningKeyBytes</div><div class="ttdoc">Gets or sets the ITokenFactory's signing key bytes.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00026">TokenFactory.cs:27</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_a726228c10e81f681ddcd34431388b595"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#a726228c10e81f681ddcd34431388b595">Tgstation.Server.Host.Security.TokenFactory.tokenHandler</a></div><div class="ttdeci">readonly JwtSecurityTokenHandler tokenHandler</div><div class="ttdoc">The JwtSecurityTokenHandler used to generate TokenResponse.Bearer strings.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00049">TokenFactory.cs:49</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_abcab65ec88a61fde94c043f5c3a66753"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#abcab65ec88a61fde94c043f5c3a66753">Tgstation.Server.Host.Security.TokenFactory.CreateToken</a></div><div class="ttdeci">string CreateToken(User user, bool serviceLogin)</div><div class="ttdoc">Create a TokenResponse for a given user .A new token string.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00104">TokenFactory.cs:104</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_abfd5781e4ec94de4df000c2af5e67e76"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#abfd5781e4ec94de4df000c2af5e67e76">Tgstation.Server.Host.Security.TokenFactory.TokenFactory</a></div><div class="ttdeci">TokenFactory(ICryptographySuite cryptographySuite, IAssemblyInformationProvider assemblyInformationProvider, IOptions< SecurityConfiguration > securityConfigurationOptions)</div><div class="ttdoc">Initializes a new instance of the TokenFactory class.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00067">TokenFactory.cs:67</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_ad8a9e89d51720db35420b0ef71fe9a28"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#ad8a9e89d51720db35420b0ef71fe9a28">Tgstation.Server.Host.Security.TokenFactory.securityConfigurationOptions</a></div><div class="ttdeci">readonly IOptions< SecurityConfiguration > securityConfigurationOptions</div><div class="ttdoc">The IOptions<TOptions> of SecurityConfiguration for the TokenFactory.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00044">TokenFactory.cs:44</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory_html_af0b547cfa6862fc9758da04ef95d0800"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_token_factory.html#af0b547cfa6862fc9758da04ef95d0800">Tgstation.Server.Host.Security.TokenFactory.tokenHeader</a></div><div class="ttdeci">JwtHeader tokenHeader</div><div class="ttdoc">The JwtHeader for generating tokens.</div><div class="ttdef"><b>Definition</b> <a href="_token_factory_8cs_source.html#l00059">TokenFactory.cs:59</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite.html">Tgstation.Server.Host.Security.ICryptographySuite</a></div><div class="ttdoc">Contains various cryptographic functions.</div><div class="ttdef"><b>Definition</b> <a href="_i_cryptography_suite_8cs_source.html#l00008">ICryptographySuite.cs:9</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite_html_af462ac6cb18181f237f934f06207bc71"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_cryptography_suite.html#af462ac6cb18181f237f934f06207bc71">Tgstation.Server.Host.Security.ICryptographySuite.GetSecureBytes</a></div><div class="ttdeci">byte[] GetSecureBytes(uint amount)</div><div class="ttdoc">Generates a secure set of bytes.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory.html">Tgstation.Server.Host.Security.ITokenFactory</a></div><div class="ttdoc">For creating TokenResponses.</div><div class="ttdef"><b>Definition</b> <a href="_i_token_factory_8cs_source.html#l00012">ITokenFactory.cs:13</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html">Tgstation.Server.Host.System.IAssemblyInformationProvider</a></div><div class="ttdoc">For retrieving the Assembly's location.</div><div class="ttdef"><b>Definition</b> <a href="_i_assembly_information_provider_8cs_source.html#l00010">IAssemblyInformationProvider.cs:11</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider_html_a681c879b4ff73db055cd6fd39cb590b7"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html#a681c879b4ff73db055cd6fd39cb590b7">Tgstation.Server.Host.System.IAssemblyInformationProvider.AssemblyName</a></div><div class="ttdeci">AssemblyName AssemblyName</div><div class="ttdoc">Gets the global::System.Reflection.AssemblyName.</div><div class="ttdef"><b>Definition</b> <a href="_i_assembly_information_provider_8cs_source.html#l00020">IAssemblyInformationProvider.cs:20</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_response_8cs_source.html#l00005">AdministrationResponse.cs:6</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_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_models_2_chat_bot_8cs_source.html#l00008">ChatBot.cs:9</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_system_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_system.html">Tgstation.Server.Host.System</a></div><div class="ttdef"><b>Definition</b> <a href="_assembly_information_provider_8cs_source.html#l00008">AssemblyInformationProvider.cs:9</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|