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

160 lines
17 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/GraphQL/AuthorizationHelper.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_26e902284bbadb812716475690544a7b.html">GraphQL</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AuthorizationHelper.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_authorization_helper_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.Linq;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Text;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>HotChocolate;</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.AspNetCore.Authorization;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </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_security.html">Tgstation.Server.Host.Security</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html"> 13</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html"> 18</a></span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html">AuthorizationHelper</a></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<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_graph_q_l_1_1_authorization_helper.html#a1bfb01379a93c58dead9f030a49f5606"> 25</a></span> <span class="keyword">public</span> <span class="keyword">static</span> GraphQLException <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html#a1bfb01379a93c58dead9f030a49f5606">ForbiddenGraphQLException</a>(<span class="keyword">this</span> AuthorizationFailure authorizationFailure)</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> ArgumentNullException.ThrowIfNull(authorizationFailure);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> var messageBuilder = <span class="keyword">new</span> StringBuilder(<span class="stringliteral">&quot;The current user is not authorized to access this resource.&quot;</span>);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">foreach</span> (var failureReason <span class="keywordflow">in</span> authorizationFailure.FailureReasons)</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> messageBuilder.AppendLine();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> messageBuilder.Append(<span class="stringliteral">&quot;\t- &quot;</span>);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> messageBuilder.Append(failureReason.Message);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">return</span> <span class="keyword">new</span>(ErrorBuilder.New()</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> .SetMessage(messageBuilder.ToString()) <span class="comment">// Copied from graphql-platform: AuthorizeMiddleware.cs</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> .SetCode(ErrorCodes.Authentication.NotAuthorized)</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> .Build());</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="}">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html#a41cdc9c24aa312bca8b972e90f5d25b4"> 52</a></span> <span class="keyword">public</span> <span class="keyword">static</span> async ValueTask <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html#a41cdc9c24aa312bca8b972e90f5d25b4">CheckGraphQLAuthorized</a>(</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">this</span> Security.IAuthorizationService authorizationService,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> IEnumerable&lt;IAuthorizationRequirement&gt;? authorizationRequirements,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">long</span>? instanceId,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">bool</span> excludeUserSessionValidRequirement = <span class="keyword">false</span>)</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> ArgumentNullException.ThrowIfNull(authorizationService);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> ArgumentNullException.ThrowIfNull(authorizationRequirements);</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> <span class="keywordflow">if</span> (!excludeUserSessionValidRequirement)</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> authorizationRequirements = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement.html">UserSessionValidRequirement</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement.html#aa1b679c648520438385095c5ad225a01">InstanceAsEnumerable</a>.Concat(authorizationRequirements);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> var result = await authorizationService.AuthorizeAsync(authorizationRequirements, instanceId);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> (!result.Succeeded)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">throw</span> result.Failure.ForbiddenGraphQLException();</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html">Tgstation.Server.Host.GraphQL.AuthorizationHelper</a></div><div class="ttdoc">Helper for authorization functionality related to GraphQL.</div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00018">AuthorizationHelper.cs:19</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper_html_a1bfb01379a93c58dead9f030a49f5606"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html#a1bfb01379a93c58dead9f030a49f5606">Tgstation.Server.Host.GraphQL.AuthorizationHelper.ForbiddenGraphQLException</a></div><div class="ttdeci">static GraphQLException ForbiddenGraphQLException(this AuthorizationFailure authorizationFailure)</div><div class="ttdoc">Create a new GraphQLException to be thrown when a forbidden error occurs.</div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00025">AuthorizationHelper.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper_html_a41cdc9c24aa312bca8b972e90f5d25b4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_authorization_helper.html#a41cdc9c24aa312bca8b972e90f5d25b4">Tgstation.Server.Host.GraphQL.AuthorizationHelper.CheckGraphQLAuthorized</a></div><div class="ttdeci">static async ValueTask CheckGraphQLAuthorized(this Security.IAuthorizationService authorizationService, IEnumerable&lt; IAuthorizationRequirement &gt;? authorizationRequirements, long? instanceId, bool excludeUserSessionValidRequirement=false)</div><div class="ttdoc">Evaluate a given set of authorizationRequirements , throwing the approriate GraphQLException on failu...</div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00052">AuthorizationHelper.cs:52</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement.html">Tgstation.Server.Host.Security.UserSessionValidRequirement</a></div><div class="ttdoc">IAuthorizationRequirement for testing if a user is enabled and their session is valid.</div><div class="ttdef"><b>Definition</b> <a href="_user_session_valid_requirement_8cs_source.html#l00010">UserSessionValidRequirement.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement_html_aa1b679c648520438385095c5ad225a01"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_user_session_valid_requirement.html#aa1b679c648520438385095c5ad225a01">Tgstation.Server.Host.Security.UserSessionValidRequirement.InstanceAsEnumerable</a></div><div class="ttdeci">static IEnumerable&lt; UserSessionValidRequirement &gt; InstanceAsEnumerable</div><div class="ttdoc">The singleton instance of this class.</div><div class="ttdef"><b>Definition</b> <a href="_user_session_valid_requirement_8cs_source.html#l00015">UserSessionValidRequirement.cs:15</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00013">AuthorizationHelper.cs:14</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><!-- 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