php-doc-en/reference/tcpwrap/functions/tcpwrap-check.xml
2011-08-16 11:38:58 +00:00

123 lines
3.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.tcpwrap-check" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tcpwrap_check</refname>
<refpurpose>Performs a tcpwrap check</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tcpwrap_check</methodname>
<methodparam><type>string</type><parameter>daemon</parameter></methodparam>
<methodparam><type>string</type><parameter>address</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>user</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>nodns</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
This function consults the <filename>/etc/hosts.allow</filename> and
<filename>/etc/hosts.deny</filename> files to check if access to service
<parameter>daemon</parameter> should be granted or denied for a client.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>daemon</parameter></term>
<listitem>
<para>
The service name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>address</parameter></term>
<listitem>
<para>
The client remote address. Can be either an IP address or a domain name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
An optional user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nodns</parameter></term>
<listitem>
<para>
If <parameter>address</parameter> looks like domain name then DNS is
used to resolve it to IP address; set <parameter>nodns</parameter> to
&true; to avoid this.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns &true; if access should be granted, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Deny all connections from localhost</title>
<para>
If your <filename>/etc/hosts.deny</filename> file contains:
</para>
<screen>
<![CDATA[
php: 127.0.0.1
]]>
</screen>
<para>
And your code looks like:
</para>
<programlisting role="php">
<![CDATA[
<?php
if (!tcpwrap_check('php', $_SERVER['REMOTE_ADDR'])) {
die('You are not welcome here');
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
For more details please consult hosts_access(3) man page.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->