File: C:/Ruby27-x64/share/doc/ruby/html/ACL.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class ACL - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-allow_addr-3F">#allow_addr?</a>
<li ><a href="#method-i-allow_socket-3F">#allow_socket?</a>
<li ><a href="#method-i-install_list">#install_list</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-ACL">
<h1 id="class-ACL" class="class">
class ACL
</h1>
<section class="description">
<p>Simple Access Control Lists.</p>
<p>Access control lists are composed of “allow” and “deny” halves to control access. Use “all” or “*” to match any address. To match a specific address use any address or address mask that <a href="IPAddr.html"><code>IPAddr</code></a> can understand.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">list</span> = <span class="ruby-node">%w[
deny all
allow 192.168.1.1
allow ::ffff:192.168.1.2
allow 192.168.1.3
]</span>
<span class="ruby-comment"># From Socket#peeraddr, see also ACL#allow_socket?</span>
<span class="ruby-identifier">addr</span> = [<span class="ruby-string">"AF_INET"</span>, <span class="ruby-value">10</span>, <span class="ruby-string">"lc630"</span>, <span class="ruby-string">"192.168.1.3"</span>]
<span class="ruby-identifier">acl</span> = <span class="ruby-constant">ACL</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">acl</span>.<span class="ruby-identifier">allow_addr?</span>(<span class="ruby-identifier">addr</span>) <span class="ruby-comment"># => true</span>
<span class="ruby-identifier">acl</span> = <span class="ruby-constant">ACL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">list</span>, <span class="ruby-constant">ACL</span><span class="ruby-operator">::</span><span class="ruby-constant">DENY_ALLOW</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">acl</span>.<span class="ruby-identifier">allow_addr?</span>(<span class="ruby-identifier">addr</span>) <span class="ruby-comment"># => true</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ALLOW_DENY">ALLOW_DENY
<dd><p>Default to allow</p>
<dt id="DENY_ALLOW">DENY_ALLOW
<dd><p>Default to deny</p>
<dt id="VERSION">VERSION
<dd><p>The current version of <a href="ACL.html"><code>ACL</code></a></p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(list=nil, order = DENY_ALLOW)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="ACL.html"><code>ACL</code></a> from <code>list</code> with an evaluation <code>order</code> of <a href="ACL.html#DENY_ALLOW"><code>DENY_ALLOW</code></a> or <a href="ACL.html#ALLOW_DENY"><code>ALLOW_DENY</code></a>.</p>
<p>An <a href="ACL.html"><code>ACL</code></a> <code>list</code> is an <a href="Array.html"><code>Array</code></a> of “allow” or “deny” and an address or address mask or “all” or “*” to match any address:</p>
<pre class="ruby"><span class="ruby-node">%w[
deny all
allow 192.0.2.2
allow 192.0.2.128/26
]</span>
</pre>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 179</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">list</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">order</span> = <span class="ruby-constant">DENY_ALLOW</span>)
<span class="ruby-ivar">@order</span> = <span class="ruby-identifier">order</span>
<span class="ruby-ivar">@deny</span> = <span class="ruby-constant">ACLList</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@allow</span> = <span class="ruby-constant">ACLList</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">install_list</span>(<span class="ruby-identifier">list</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">list</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-allow_addr-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">allow_addr?</span><span
class="method-args">(addr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Allow connections from addrinfo <code>addr</code>? It must be formatted like Socket#peeraddr:</p>
<pre class="ruby">[<span class="ruby-string">"AF_INET"</span>, <span class="ruby-value">10</span>, <span class="ruby-string">"lc630"</span>, <span class="ruby-string">"192.0.2.1"</span>]
</pre>
<div class="method-source-code" id="allow_addr-3F-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">allow_addr?</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@order</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">DENY_ALLOW</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@allow</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@deny</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">ALLOW_DENY</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@deny</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@allow</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-allow_socket-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">allow_socket?</span><span
class="method-args">(soc)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Allow connections from <a href="Socket.html"><code>Socket</code></a> <code>soc</code>?</p>
<div class="method-source-code" id="allow_socket-3F-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 191</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">allow_socket?</span>(<span class="ruby-identifier">soc</span>)
<span class="ruby-identifier">allow_addr?</span>(<span class="ruby-identifier">soc</span>.<span class="ruby-identifier">peeraddr</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_list</span><span
class="method-args">(list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>list</code> of <a href="ACL.html"><code>ACL</code></a> entries to this <a href="ACL.html"><code>ACL</code></a>.</p>
<div class="method-source-code" id="install_list-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 223</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_list</span>(<span class="ruby-identifier">list</span>)
<span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">i</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">list</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">permission</span>, <span class="ruby-identifier">domain</span> = <span class="ruby-identifier">list</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-identifier">i</span>,<span class="ruby-value">2</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">permission</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'allow'</span>
<span class="ruby-ivar">@allow</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">domain</span>)
<span class="ruby-keyword">when</span> <span class="ruby-string">'deny'</span>
<span class="ruby-ivar">@deny</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">domain</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Invalid ACL entry #{list}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>