Files
tgstation-server/_i_system_identity_8cs_source.html

124 lines
13 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/ISystemIdentity.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ISystemIdentity.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_system_identity_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.Threading;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading.Tasks;</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.html">Tgstation.Server.Host.Security</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="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html"> 10</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">ISystemIdentity</a> : <a class="code hl_class" href="class_i_disposable.html">IDisposable</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="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a21339e0b4c3d045ba30c6ac6ea15aa4f"> 15</a></span> <span class="keywordtype">string</span> <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a21339e0b4c3d045ba30c6ac6ea15aa4f">Uid</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="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#abdae9176f2609703ff36c43d7af97ac1"> 20</a></span> <span class="keywordtype">string</span> <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#abdae9176f2609703ff36c43d7af97ac1">Username</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="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a372abf6465e892a3fee94c1aa32aaf3f"> 25</a></span> <span class="keywordtype">bool</span> <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a372abf6465e892a3fee94c1aa32aaf3f">CanCreateSymlinks</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="l00031" name="l00031"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a6d39482ea5e287200a0e6bb4796e7168"> 31</a></span> <span class="keywordtype">bool</span> <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a6d39482ea5e287200a0e6bb4796e7168">IsSuperUser</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a1cb40673b65fa830543c69461449953a"> 37</a></span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">ISystemIdentity</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a1cb40673b65fa830543c69461449953a">Clone</a>();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a9b525a56c704424ce14e78edcb7d003e"> 45</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a9b525a56c704424ce14e78edcb7d003e">RunImpersonated</a>(Action action, CancellationToken cancellationToken);</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 class="ttc" id="aclass_i_disposable_html"><div class="ttname"><a href="class_i_disposable.html">IDisposable</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">Tgstation.Server.Host.Security.ISystemIdentity</a></div><div class="ttdoc">Represents a user on the current global::System.Runtime.InteropServices.OSPlatform.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00010">ISystemIdentity.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_a1cb40673b65fa830543c69461449953a"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a1cb40673b65fa830543c69461449953a">Tgstation.Server.Host.Security.ISystemIdentity.Clone</a></div><div class="ttdeci">ISystemIdentity Clone()</div><div class="ttdoc">Clone the ISystemIdentity creating another copy that must have IDisposable.Dispose called on it.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_a21339e0b4c3d045ba30c6ac6ea15aa4f"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a21339e0b4c3d045ba30c6ac6ea15aa4f">Tgstation.Server.Host.Security.ISystemIdentity.Uid</a></div><div class="ttdeci">string Uid</div><div class="ttdoc">A unique identifier for the user.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00015">ISystemIdentity.cs:15</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_a372abf6465e892a3fee94c1aa32aaf3f"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a372abf6465e892a3fee94c1aa32aaf3f">Tgstation.Server.Host.Security.ISystemIdentity.CanCreateSymlinks</a></div><div class="ttdeci">bool CanCreateSymlinks</div><div class="ttdoc">If this system identity has permissions to create symlinks.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00025">ISystemIdentity.cs:25</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_a6d39482ea5e287200a0e6bb4796e7168"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a6d39482ea5e287200a0e6bb4796e7168">Tgstation.Server.Host.Security.ISystemIdentity.IsSuperUser</a></div><div class="ttdeci">bool IsSuperUser</div><div class="ttdoc">Is this identity a SuperUser for the OS. See Administrator on Windows or root on Linux.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00031">ISystemIdentity.cs:31</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_a9b525a56c704424ce14e78edcb7d003e"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#a9b525a56c704424ce14e78edcb7d003e">Tgstation.Server.Host.Security.ISystemIdentity.RunImpersonated</a></div><div class="ttdeci">Task RunImpersonated(Action action, CancellationToken cancellationToken)</div><div class="ttdoc">Runs a given action in the context of the ISystemIdentity.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html_abdae9176f2609703ff36c43d7af97ac1"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html#abdae9176f2609703ff36c43d7af97ac1">Tgstation.Server.Host.Security.ISystemIdentity.Username</a></div><div class="ttdeci">string Username</div><div class="ttdoc">The user's name.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00020">ISystemIdentity.cs:20</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>