A list of ACL permit and deny entries with a permitAccess method which tells whether candidate addresses are permitted or denied by this ACL list.

The ACL file is reloaded whenever a modification to it is detected. If you copy in a file with an older file date, you will need to touch it.

The public runtime method is permitAccess(). The public setup method is the constructor.

Each non-comment line in the ACL file must be a rule of the format:

{allow|deny} <ip_address>[/significant-bits]

For example

allow ahostname
    deny ahost.domain.com
    allow 127.0.0.1
    allow 2001:db8::/32

In order to detect bit specification mistakes, we require that non-significant bits be zero in the values. An undesirable consequence of this is, you can't use a specification like the following to mean "all of the hosts on the same network as x.admc.com":

allow x.admc.com/24

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ServerAcl.AclEntry
public static class	ServerAcl.AclFormatException
private static class	ServerAcl.InternalException

Field Summary

Modifier and Type	Field and Description
private List<ServerAcl.AclEntry>	aclEntries
private File	aclFile
pack-priv static final byte[]	ALL_SET_16BYTES
pack-priv static final byte[]	ALL_SET_4BYTES
private long	lastLoadTime
private static ServerAcl.AclEntry	PROHIBIT_ALL_IPV4
private static ServerAcl.AclEntry	PROHIBIT_ALL_IPV6
private PrintWriter	pw

Constructor Summary

Access	Constructor and Description
public	ServerAcl(File aclFile)

Method Summary

Modifier and Type	Method and Description
public static String	colonNotation(byte[] Unsigned byte array uba) Returns: String
public static String	dottedNotation(byte[] Unsigned byte array uba) Returns: String
pack-priv synchronized void	ensureAclsUptodate()
pack-priv List<ServerAcl.AclEntry>	load()
public static void	main(String[] String[] sa) Utility method that allows interactive testing of individual ACL records, as well as the net effect of the ACL record list.
public boolean	Returns: boolean permitAccess(String String s) Uses system network libraries to resolve the given String to an IP addr, then determine whether this address is permitted or denied.
public boolean	permitAccess(byte[] byte[] addr) Returns: true if access for the candidate address should be permitted, false if access should be denied.
private void	println(String s)
public void	setPrintWriter(PrintWriter pw)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

aclEntries	back to summary
private List<ServerAcl.AclEntry> aclEntries

aclFile	back to summary
private File aclFile

ALL_SET_16BYTES	back to summary
pack-priv static final byte[] ALL_SET_16BYTES

ALL_SET_4BYTES	back to summary
pack-priv static final byte[] ALL_SET_4BYTES

lastLoadTime	back to summary
private long lastLoadTime

PROHIBIT_ALL_IPV4	back to summary
private static ServerAcl.AclEntry PROHIBIT_ALL_IPV4

PROHIBIT_ALL_IPV6	back to summary
private static ServerAcl.AclEntry PROHIBIT_ALL_IPV6

pw	back to summary
private PrintWriter pw

Constructor Detail

ServerAcl	back to summary
public ServerAcl(File aclFile) throws IOException, AclFormatException

Method Detail

colonNotation	back to summary
public static String colonNotation(byte[] uba) Parameters uba:byte[] Unsigned byte array Returns:String String

dottedNotation	back to summary
public static String dottedNotation(byte[] uba) Parameters uba:byte[] Unsigned byte array Returns:String String

ensureAclsUptodate	back to summary
pack-priv synchronized void ensureAclsUptodate()

load	back to summary
pack-priv List<ServerAcl.AclEntry> load() throws IOException, AclFormatException

main	back to summary
public static void main(String[] sa) throws AclFormatException, IOException Utility method that allows interactive testing of individual ACL records, as well as the net effect of the ACL record list. Run "java -cp path/to/hsqldb.jar org.hsqldb.server.ServerAcl --help" for Syntax help. Parameters sa:String[] String[] Exceptions AclFormatException: when badly formatted IOException: when io error

main

back to summary

public static void main(String[] sa) throws AclFormatException, IOException

Utility method that allows interactive testing of individual ACL records, as well as the net effect of the ACL record list. Run "java -cp path/to/hsqldb.jar org.hsqldb.server.ServerAcl --help" for Syntax help.

Parameters

sa:String[]: String[]

Exceptions

AclFormatException:: when badly formatted
IOException:: when io error

permitAccess back to summary

permitAccess	back to summary
public boolean permitAccess(String s) Uses system network libraries to resolve the given String to an IP addr, then determine whether this address is permitted or denied. Specified name may be a numerical-based String like "1.2.3.4", a constant known to the networking libraries, or a host name to be resolved by the systems name resolution system. If the given String can't be resolved to an IP addr, false is returned. Parameters s:String String Returns:boolean boolean See Also `permitAccess(byte[])`

public boolean permitAccess(String s)

Uses system network libraries to resolve the given String to an IP addr, then determine whether this address is permitted or denied. Specified name may be a numerical-based String like "1.2.3.4", a constant known to the networking libraries, or a host name to be resolved by the systems name resolution system. If the given String can't be resolved to an IP addr, false is returned.

Parameters

s:String: String

Returns:boolean

boolean

See Also

permitAccess(byte[])

permitAccess	back to summary
public boolean permitAccess(byte[] addr) Parameters addr:byte[] byte[] Returns:boolean true if access for the candidate address should be permitted, false if access should be denied.

println	back to summary
private void println(String s)

setPrintWriter	back to summary
public void setPrintWriter(PrintWriter pw)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

org.hsqldb.server back to summary

private final Class ServerAcl.AclEntry

Class Inheritance

extends Object

java.lang.Object
org.hsqldb.server.ServerAcl.AclEntry

Field Summary

Modifier and Type	Field and Description
public boolean	allow
private int	bitBlockSize
private byte[]	mask
private byte[]	value

Constructor Summary

Access	Constructor and Description
public	AclEntry(byte[] value, int bitBlockSize, boolean allow)

Method Summary

Modifier and Type	Method and Description
public boolean	matches(byte[] candidate)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validateMask()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

allow	back to summary
public boolean allow

bitBlockSize	back to summary
private int bitBlockSize

mask	back to summary
private byte[] mask

value	back to summary
private byte[] value

Constructor Detail

AclEntry	back to summary
public AclEntry(byte[] value, int bitBlockSize, boolean allow) throws AclFormatException

Method Detail

matches	back to summary
public boolean matches(byte[] candidate)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

validateMask	back to summary
public void validateMask() throws AclFormatException

public final Class ServerAcl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ServerAcl.AclEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ServerAcl.AclFormatException

Constructor Summary

Constructor Detail

private final Class ServerAcl.InternalException

Constructor Summary

Constructor Detail