ipaccess 1.2.0 → 1.2.2

data/lib/ipaccess/ghost_doc/ghost_doc_p_blacklist_e.rb

@@ -1,7 +0,0 @@
-# :call-seq:
-#   blacklist!(*addresses)<br />
-#   blacklist!(list, *addresses)
-# 
-# This method works same way as blacklist
-# but it will allow you to modify the list
-# even if the global access set is used by object.

data/lib/ipaccess/ghost_doc/ghost_doc_p_unblacklist.rb

@@ -1,36 +0,0 @@
-# :call-seq:
-#   unblacklist(*addresses)<br />
-#   unblacklist(list, *addresses)
-# 
-# This method removes blacklisted IP address(-es)
-# from the input or output access list selected
-# by the *list* argument (+:input+ or +:output+).
-# If the access list selector is omited it
-# operates on the default access list that certain
-# kind of network object uses. The allowed format of address
-# is the same as for IPAccess.to_cidrs.
-# This method will not add nor remove any
-# whitelisted item.
-# 
-# === Restrictions
-# 
-# This method won't allow you to modify the list if
-# the global access set is associated with an object.
-# You may operate on IPAccess::Set.Global or use
-# unblacklist! instead.
-# 
-# === Return value
-# 
-# It will return the result of calling
-# IPAccess::List#unblacklist on the list.
-# 
-# === Revalidation
-#
-# After modyfing access set current connection
-# is validated again to avoid access leaks.
-# 
-# === DNS Warning
-#
-# You should avoid passing hostnames as arguments since
-# DNS is not reliable and responses may change with time,
-# which may cause security flaws.

data/lib/ipaccess/ghost_doc/ghost_doc_p_unblacklist_e.rb

@@ -1,7 +0,0 @@
-# :call-seq:
-#   unblacklist!(*addresses)<br />
-#   unblacklist!(list, *addresses)
-#
-# This method works same way as unblacklist
-# but it will allow you to modify the list
-# even if the global access set is used by object.

data/lib/ipaccess/ghost_doc/ghost_doc_p_unwhitelist.rb

@@ -1,36 +0,0 @@
-# :call-seq:
-#   unwhitelist(*addresses)<br />
-#   unwhitelist(list, *addresses)
-# 
-# This method removes whitelisted IP address(-es)
-# from the input or output access list selected
-# by the *list* argument (+:input+ or +:output+).
-# If the access list selector is omited it
-# operates on the default access list that certain
-# kind of network object uses. The allowed format of address
-# is the same as for IPAccess.to_cidrs.
-# This method will not add nor remove any
-# blacklisted item.
-# 
-# === Restrictions
-# 
-# This method won't allow you to modify the list if
-# the global access set is associated with an object.
-# You may operate on IPAccess::Set.Global or use
-# unwhitelist! instead.
-# 
-# === Return value
-# 
-# It will return the result of calling
-# IPAccess::List#unwhitelist on the list.    
-# 
-# === Revalidation
-#
-# After modyfing access set current connection
-# is validated again to avoid access leaks.
-# 
-# === DNS Warning
-#
-# You should avoid passing hostnames as arguments since
-# DNS is not reliable and responses may change with time,
-# which may cause security flaws.

data/lib/ipaccess/ghost_doc/ghost_doc_p_unwhitelist_e.rb

@@ -1,7 +0,0 @@
-# :call-seq:
-#   unwhitelist!(*addresses)<br />
-#   unwhitelist!(list, *addresses)
-# 
-# This method works same way as unwhitelist
-# but it will allow you to modify the list
-# even if the global access set is used by object.

data/lib/ipaccess/ghost_doc/ghost_doc_p_whitelist.rb

@@ -1,36 +0,0 @@
-# :call-seq:
-#   whitelist(*addresses)<br />
-#   whitelist(list, *addresses)
-# 
-# This method whitelists IP address(-es) in
-# the input or output access list selected
-# by the *list* argument (+:input+ or +:output+).
-# If the access list selector is omited it
-# operates on the default access list that certain
-# kind of network object uses. The allowed format of address
-# is the same as for IPAccess.to_cidrs.
-# This method will not add nor remove any
-# blacklisted item.
-# 
-# === Restrictions
-# 
-# This method won't allow you to modify the list if
-# the global access set is associated with an object.
-# You may operate on IPAccess::Set.Global or use
-# whitelist! instead.
-# 
-# === Return value
-# 
-# It will return the result of calling
-# IPAccess::List#whitelist on the list.    
-# 
-# === Revalidation
-#
-# After modyfing access set current connection
-# is validated again to avoid access leaks.
-# 
-# === DNS Warning
-#
-# You should avoid passing hostnames as arguments since
-# DNS is not reliable and responses may change with time,
-# which may cause security flaws.

data/lib/ipaccess/ghost_doc/ghost_doc_p_whitelist_e.rb

@@ -1,7 +0,0 @@
-# :call-seq:
-#   whitelist!(*addresses)<br />
-#   whitelist!(list, *addresses)
-# 
-# This method works same way as whitelist
-# but it will allow you to modify the list
-# even if the global access set is used by object.

data/lib/ipaccess/ghost_doc/ghost_doc_patched_usage.rb

@@ -1,64 +0,0 @@
-# Access checks are lazy,
-# which means they are performed when
-# a real connection is going to happend.
-# 
-# Instances of this class will also
-# internally use patched versions of Ruby's network
-# socket objects to avoid access leaks.
-# 
-# You can pass access set in various ways: while
-# creating a new object or while a communication is
-# already started. You can also rely on a global
-# access set, which is used by default.
-#
-# === Usage
-# 
-# There are 3 ways to enable access control:
-#
-# * by patching original class (see IPAccess.arm) – use it in code that you cannot modify
-# * by patching single instance (see IPAccess.arm) – use it occasionally
-# * by using instances of this class directly – use it in your own code
-# 
-# There are also 4 ways to manage access rules:
-# 
-# * by using direct methods like blacklist and whitelist – preferred
-# * by using +acl+ member – low-level
-# * by using <tt>IPAccess::Set.Global</tt> constant – controls a global access set
-# * by using methods of an external IPAccess::Set object associated with an instance
-# 
-# ==== Using direct methods
-# 
-# Patched network objects and variants have methods to control access.
-# You should use them since they are most reliable way to perform
-# modifications on an working instance. These methods (documented
-# below) are: whitelist, blacklist, whitelist! and blacklist!.
-# Each of the methods ensures that needed safety checks are made
-# when detecting some change in access lists.
-# 
-# ==== Using +acl+ member
-# 
-# The +acl+ member gives you direct access to internal IPAccess::Set
-# instance that an object uses to control an access. However,
-# by accessing this member you may only modify private and shared
-# access sets, and you have to manually re-check connection against lists
-# (e.g. by using method acl_recheck).
-# 
-# ==== Using IPAccess::Set.Global
-# 
-# You may use IPAccess::Set.Global to add or remove rules
-# conatined in lists of a global access set. You should use
-# it before some network objects are created and if it's not
-# possible call acl_recheck for any object that is using it
-# when some changes in rules are made. It is also possible
-# to manipulate global access set from object's scope using
-# whitelist! and blacklist! methods. For working
-# objects you should use them.
-# 
-# ==== Using external access set
-# 
-# External access sets are simply IPAccess::Set objects
-# that were associated with an instance during initialization
-# or by assigning it to +acl+ member. You may manipulate their
-# access rules safely before a networking object is in
-# a connected state. After it happens it is safer to use
-# direct controlling methods that network object provides.