doc/reference.xml

   1  <chapter id="proxy-reference">
   2   <title>Proxy Reference</title>
   3   <section id="proxy-operation">
   4    <title>Operating Environment</title>
   5    <para>
   6     The YAZ proxy is a console program. After startup it spawns
   7     a child process (except on Windows or if option -X is given).
   8     The child process is the core of the proxy and it handles all
   9     communication with clients and servers. The parent process
  10     will restart the child process if it dies unexpectedly and report
  11     the reason. For options for YAZ proxy,
  12     see <xref linkend="proxy-usage"/>.
  13    </para>
  14    <para>
  15     As an option, the proxy may change user identity to a less privileged
  16     user.
  17    </para>
  18   </section>
  19   <section id="proxy-target">
  20    <title>Choosing the Backend Server</title>
  21    <para>
  22     When the proxy receives a Z39.50 Initialize Request from a Z39.50
  23     client, it determines the backend server by the following rules:
  24     <orderedlist>
  25      <listitem>
  26       <para>If the <literal>InitializeRequest</literal> PDU from the
  27        client includes an
  28        <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
  29        element with OID
  30        <literal>1.2.840.10003.10.1000.81.1</literal>, then the
  31        contents of that element specify the server to be used, in the
  32        usual YAZ address format (typically
  33        <literal>tcp:<parameter>hostname</parameter>:<parameter>port</parameter></literal>)
  34        as described in
  35        <ulink url="&url.yaz.comstack.addresses;"
  36         >the Addresses section of the YAZ manual</ulink>.
  37       </para>
  38      </listitem>
  39
  40      <listitem>
  41       <para>Otherwise, the Proxy uses the default server, if one was
  42        specified in the proxy configuration file. See
  43        <xref linkend="proxy-config-target"/>.
  44       </para>
  45      </listitem>
  46
  47      <listitem>
  48       <para>Otherwise, the Proxy uses the default server, if one was
  49        specified on the command-line with the <literal>-t</literal>
  50        option.
  51       </para>
  52      </listitem>
  53      <listitem>
  54       <para>Otherwise, the proxy closes the connection with
  55        the client.
  56       </para>
  57      </listitem>
  58     </orderedlist>
  59    </para>
  60    <para>
  61     If the proxy receives an SRU request, the following rules are used.
  62     <orderedlist>
  63      <listitem>
  64       <para>If default target has Explain information with a
  65        <literal>database</literal> that matches the path of the
  66        HTTP request of SRU that backend server is used for SRU operation.
  67       </para>
  68      </listitem>
  69      <listitem>
  70       <para>
  71        Otherwise the service will return HTTP 404 (Not found).
  72       </para>
  73      </listitem>
  74     </orderedlist>
  75    </para>
  76   </section>
  77   <section id="proxy-keepalive">
  78    <title>Keep-alive Facility</title>
  79    <para>
  80     The keep-alive is a facility where the proxy keeps the connection to the
  81     backend server - even if the client closes the connection to the proxy.
  82    </para>
  83    <para>
  84     If a new or another client connects to the proxy again and requests the
  85     same backend it will be reassigned to this backend. In this case, the
  86     proxy sends an initialize response directly to the client and an
  87     initialize handshake with the backend is omitted.
  88    </para>
  89    <para>
  90     When a client reconnects, query and record caching works better, if the
  91     proxy assigns it to the same backend as before. And the result set
  92     (if any) is re-used. To achieve this, Index Data defined a session
  93     cookie which identifies the backend session.
  94    </para>
  95    <para>
  96     The cookie is defined by the client and is sent as part of the
  97     Initialize Request and passed in an
  98     <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
  99     element with OID <literal>1.2.840.10003.10.1000.81.2</literal>.
 100    </para>
 101    <para>
 102     Clients that do not send a cookie as part of the initialize request
 103     may still better performance, since the init handshake is saved.
 104    </para>
 105    <para>
 106     Refer to <xref linkend="proxy-config-keepalive"/> on how to setup
 107     configuration parameters for keepalive.
 108     </para>
 109   </section>
 110
 111
 112   <section id="query-cache">
 113    <title>Query Caching</title>
 114    <para>
 115     Simple stateless clients often send identical Z39.50 searches
 116     in a relatively short period of time (e.g. in order to produce a
 117     results-list page, the next page,
 118     a single full-record, etc). And for many targets, it's
 119     much more expensive to produce a new result set than to
 120     reuse an existing one.
 121    </para>
 122    <para>
 123     The proxy tries to solve that by remembering the last query for each
 124     backend target, so that if an identical query is received next, it
 125     is turned into Present Requests rather than new Search Requests.
 126    </para>
 127    <note>
 128     <para>
 129      In a future we release will will probably allows for
 130      an arbitrary-sized cache for targets supporting named result sets.
 131     </para>
 132    </note>
 133    <para>
 134     You can enable/disable query caching using option -o.
 135    </para>
 136   </section>
 137
 138   <section id="record-cache">
 139    <title>Record Caching</title>
 140    <para>
 141     As an option, the proxy may also cache result set records for the
 142     last search.
 143     The proxy takes into account the Record Syntax and CompSpec.
 144     The CompSpec includes simple element set names as well.
 145     By default the cache is 200000 bytes per session.
 146    </para>
 147   </section>
 148
 149   <section id="query-validation">
 150    <title>Query Validation</title>
 151    <para>
 152     The Proxy may also be configured to trap particular attributes in
 153     Type-1 queries and send Bib-1 diagnostics back to the client without
 154     even consulting the backend target. This facility may be useful if
 155     a target does not properly issue diagnostics when unsupported attributes
 156     are send to it.
 157    </para>
 158   </section>
 159
 160    <section id="record-validation">
 161    <title>Record Syntax Validation</title>
 162    <para>
 163     The proxy may be configured to accept, reject or convert records.
 164     When accepted, the target passes search/present requests to the
 165     backend target under the assumption that the target can honor the
 166     request (In fact it may not do that). When a record is rejected because
 167     the record syntax is "unsupported" the proxy returns a diagnostic to the
 168     client. Finally, the proxy may convert records.
 169    </para>
 170    <para>
 171     The proxy can convert from MARC to MARCXML and thereby offer an
 172     XML version of any MARC record as long as it is ISO2709 encoded.
 173     If the proxy is compiled with libXSLT support it can also
 174     perform XSLT on XML.
 175    </para>
 176   </section>
 177
 178   <section id="other-optimizations">
 179    <title>Other Optimizations</title>
 180    <para>
 181     We've had some plans to support global caching of result set records,
 182     but this has not yet been implemented.
 183    </para>
 184   </section>
 185
 186   <section id="proxy-config-file">
 187    <title>Proxy Configuration File</title>
 188    <para>
 189     The Proxy may read a configuration file using option
 190     <literal>-c</literal> followed by the filename of a config file.
 191    </para>
 192    <para>
 193     The config file is XML based. The YAZ proxy must be compiled
 194     with <ulink url="&url.libxml2;">libxml2</ulink> and
 195     <ulink url="&url.libxslt;">libXSLT</ulink> support in
 196     order for the config file facility to be enabled.
 197    </para>
 198    <para>
 199     See <xref linkend="yazproxy-schema"/> for an XML schema
 200     for the configuration.
 201    </para>
 202    <tip>
 203     <para>To check for a config file to be well-formed, the yazproxy may
 204      be invoked without specifying a listening port, i.e.
 205      <screen>
 206       yazproxy -c myconfig.xml
 207      </screen>
 208      If this does not produce errors, the file is well-formed.
 209     </para>
 210    </tip>
 211    <section id="proxy-config-header">
 212     <title>Proxy Configuration Header</title>
 213     <para>
 214      The proxy config file must have a root element called
 215      <literal>proxy</literal> and scoped within namespace
 216      <literal> xmlns="http://indexdata.dk/yazproxy/schema/0.9/"</literal>.
 217      All information except an optional XML header must be stored
 218      within the <literal>proxy</literal> element.
 219     </para>
 220     <screen>
 221      &lt;?xml version="1.0"?>
 222      &lt;proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
 223       &lt;!-- content here .. -->
 224      &lt;/proxy>
 225     </screen>
 226    </section>
 227    <section id="proxy-config-target">
 228     <title>target</title>
 229     <para>
 230      The element <literal>target</literal> which may be repeated zero
 231      or more times with parent element <literal>proxy</literal> contains
 232      information about each backend target.
 233      The <literal>target</literal> element have two attributes:
 234      <literal>name</literal> which holds the logical name of the backend
 235      target (required) and <literal>default</literal> (optional) which
 236      (when given) specifies that the backend target is the default target -
 237      equivalent to command line option <literal>-t</literal>.
 238     </para>
 239     <para>
 240       <screen><![CDATA[
 241      <?xml version="1.0"?>
 242      <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
 243       <target name="server1" default="1">
 244        <!-- description of server1 .. -->
 245       </target>
 246       <target name="server2">
 247        <!-- description of server2 .. -->
 248       </target>
 249      </proxy>
 250       ]]>
 251      </screen>
 252     </para>
 253    </section>
 254    <section id="proxy-config-url">
 255     <title>url</title>
 256     <para>
 257      The <literal>url</literal> which may be repeated one or more times
 258      should be the child of the <literal>target</literal> element.
 259      The CDATA of <literal>url</literal> is the Z-URL of the backend.
 260     </para>
 261     <para>
 262      Multiple <literal>url</literal> element may be used. In that case, then
 263      a client initiates a session, the proxy chooses the URL with the lowest
 264      number of active sessions, thereby distributing the load. It is
 265      assumed that each URL represents the same database (data).
 266     </para>
 267    </section>
 268
 269    <section id="proxy-config-target-timeout">
 270     <title>target-timeout</title>
 271     <para>
 272      The element <literal>target-timeout</literal> is the child of element
 273      <literal>target</literal> and specifies the amount in seconds before
 274      a target session is shut down.
 275     </para>
 276     <para>
 277      This can also be specified on the command line by using option
 278      <literal>-T</literal>. Refer to OPTIONS in <xref linkend="proxy-usage"/>.
 279     </para>
 280    </section>
 281
 282    <section id="proxy-config-client-timeout">
 283     <title>client-timeout</title>
 284     <para>
 285      The element <literal>client-timeout</literal> is the child of element
 286      <literal>target</literal> and specifies the amount in seconds before
 287      a client session is shut down.
 288      </para>
 289     <para>
 290      This can also be specified on the command line by using option
 291      <literal>-i</literal>.  Refer to OPTIONS in <xref linkend="proxy-usage"/>.
 292     </para>
 293    </section>
 294
 295    <section id="proxy-config-max-sockets">
 296     <title>max-sockets</title>
 297     <para>
 298      The element <literal>max-sockets</literal> is the child of element
 299      <literal>target</literal> and specifies the maximum number of sockets
 300      to use for the target for all sessions using it. In other words: maximum
 301      number of Z39.50 session to the target.
 302     </para>
 303    </section>
 304
 305    <section id="proxy-config-keepalive">
 306     <title>keepalive</title>
 307     <para>The <literal>keepalive</literal> element holds information about
 308      the keepalive Z39.50 sessions. Keepalive sessions are proxy-to-backend
 309      sessions that is no longer associated with a client session.
 310     </para>
 311     <para>The <literal>keepalive</literal> element which is the child of
 312      the <literal>target</literal>holds two elements:
 313      <literal>bandwidth</literal> and <literal>pdu</literal>.
 314      The <literal>bandwidth</literal> is the maximum total bytes
 315      transferred to/from the target. If a target session exceeds this
 316      limit, it is shut down (and no longer kept alive).
 317      The <literal>pdu</literal> is the maximum number of requests sent
 318      to the target. If a target session exceeds this limit, it is
 319      shut down. The idea of these two limits is that avoid very long
 320      sessions that use resources in a backend (that leaks!).
 321     </para>
 322     <para>
 323      The following sets maximum number of bytes transferred in a
 324      target session to 1 MB and maximum of requests to 400.
 325      <screen>
 326       &lt;keepalive>
 327        &lt;bandwidth>1048576&lt;/bandwidth>
 328        &lt;pdu>400&lt;/pdu>
 329       &lt;/keepalive>
 330      </screen>
 331     </para>
 332    </section>
 333    <section id="proxy-config-limit">
 334     <title>limit</title>
 335     <para>
 336      The <literal>limit</literal> section specifies bandwidth/pdu requests
 337      limits for an active session.
 338      The proxy records bandwidth/pdu requests during the last 60 seconds
 339      (1 minute). The <literal>limit</literal> may include the
 340      elements <literal>bandwidth</literal>, <literal>pdu</literal>,
 341      <literal>retrieve</literal> and <literal>search</literal>.
 342      The <literal>bandwidth</literal>
 343      measures the number of bytes transferred within the last minute.
 344      The <literal>pdu</literal> is the number of requests in the last
 345      minute. The <literal>retrieve</literal> holds the maximum records to
 346      which may be retrieved in one Present Request.
 347      The <literal>search</literal> is the maximum number of searches
 348      within the last minute.
 349     </para>
 350     <para>
 351      If a bandwidth/pdu/search limit is reached the proxy will postpone the
 352      requests to the target and wait one or more seconds. The idea of the
 353      limit is to ensure that clients that downloads hundreds or thousands of
 354      records do not hurt other users.
 355     </para>
 356     <para>
 357      The following sets maximum number of bytes transferred per minute to
 358      500Kbytes, maximum number of records retrievals to 40
 359      and maximum number of searches to 20.
 360      <screen>
 361       &lt;limit>
 362        &lt;bandwidth>524288&lt;/bandwidth>
 363        &lt;retrieve>40&lt;/retrieve>
 364        &lt;search>20&lt;/search>
 365       &lt;/limit>
 366      </screen>
 367     </para>
 368     <note>
 369      <para>
 370       Typically the values in the keepalive section are mugh higher
 371       than their equivalent limit counterparts (bandwidth, pdu).
 372      </para>
 373     </note>
 374    </section>
 375
 376    <section id="proxy-config-attribute">
 377     <title>attribute</title>
 378     <para>
 379      The <literal>attribute</literal> element specifies accept or reject
 380      or a particular attribute type, value pair.
 381      Well-behaving targets will reject unsupported attributes on their
 382      own. This feature is useful for targets that do not gracefully
 383      handle unsupported attributes.
 384     </para>
 385     <para>
 386      Attribute elements may be repeated. The proxy inspects the attribute
 387      specifications in the order as specified in the configuration file.
 388      When a given attribute specification matches a given attribute list
 389      in a query, the proxy takes appropriate action (reject, accept).
 390     </para>
 391     <para>
 392      If no attribute specifications matches the attribute list in a query,
 393      it is accepted.
 394     </para>
 395     <para>
 396      The <literal>attribute</literal> element has two required attributes:
 397      <literal>type</literal> which is the Attribute Type-1 type, and
 398      <literal>value</literal> which is the Attribute Type-1 value.
 399      The special value/type <literal>*</literal> matches any attribute
 400      type/value. A value may also be specified as a list with each
 401      value separated by comma, a value may also be specified as a
 402      list: low value - dash - high value.
 403     </para>
 404     <para>
 405      If attribute <literal>error</literal> is given, that holds a
 406      Bib-1 diagnostic which is sent to the client if the particular
 407      type, value is part of a query.
 408     </para>
 409     <para>
 410      If attribute <literal>error</literal> is not given, the attribute
 411      type, value is accepted and passed to the backend target.
 412     </para>
 413     <para>
 414      A target that supports use attributes 1,4, 1000 through 1003 and
 415      no other use attributes, could use the following rules:
 416      <screen>
 417       &lt;attribute type="1" value="1,4,1000-1003"/>
 418       &lt;attribute type="1" value="*" error="114"/>
 419      </screen>
 420     </para>
 421    </section>
 422    <section id="proxy-config-syntax">
 423     <title>syntax</title>
 424     <para>
 425      The <literal>syntax</literal> element specifies accept or reject
 426      or a particular record syntax request from the client.
 427     </para>
 428     <para>
 429      The <literal>syntax</literal> has one required attribute:
 430      <literal>type</literal> which is the Preferred Record Syntax.
 431     </para>
 432     <para>
 433      If attribute <literal>error</literal> is given, that holds a
 434      Bib-1 diagnostic which is sent to the client if the particular
 435      record syntax is part of a present - or search request.
 436     </para>
 437     <para>
 438      If attribute <literal>error</literal> is not given, the record syntax
 439      is accepted and passed to the backend target.
 440     </para>
 441     <para>
 442      If attribute <literal>marcxml</literal> is given, the proxy will
 443      perform MARC21 to MARCXML conversion. In this case the
 444      <literal>type</literal> should be XML. The proxy will use
 445      preferred record syntax USMARC/MARC21 or <literal>backendtype</literal>
 446      (if given) against the backend target.
 447      For the special case where <literal>backendtype</literal> is
 448      <literal>opac</literal> the proxy will convert the OPAC
 449      record to OPACXML.
 450     </para>
 451     <para>
 452      If attribute <literal>backendtype</literal> is given, that holds the
 453      record syntax to be transmitted to backend.
 454     </para>
 455     <para>
 456      If attribute <literal>stylesheet</literal> is given, the proxy
 457      will convert XML record from server via XSLT. It is important
 458      that the content from server is XML. If used in conjunction with
 459      attribute <literal>marcxml</literal>, the MARC to MARCXML/OPACXML
 460      conversion takes place before the XSLT conversion takes place.
 461     </para>
 462     <para>
 463      If attribute <literal>identifier</literal> is given that is the
 464      SRU record schema identifier for the resulting output record (after
 465      MARCXML and/or XSLT conversion).
 466     </para>
 467     <para>
 468      If sub element <literal>title</literal> is given (as child element
 469      of <literal>syntax</literal>, then that is the official SRU
 470      name of the resulting record schema.
 471     </para>
 472     <para>
 473      If sub element <literal>name</literal> is given that is an alias
 474      for the record schema identifier. Multiple <literal>name</literal>s
 475      may be specified.
 476     </para>
 477     <example>
 478      <title>MARCXML conversion</title>
 479      <para>To accept USMARC and offer MARCXML XML plus Dublin Core (via
 480       XSLT conversion) but the following configuration could be used:
 481       <screen>
 482        &lt;proxy>
 483        &lt;target name="mytarget">
 484        ..
 485        &lt;syntax type="usmarc"/>
 486        &lt;syntax type="xml" marcxml="1"
 487          identifier="info:srw/schema/1/marcxml-v1.1"
 488          &lt;title>MARCXML&lt;title>
 489          &lt;name>marcxml&lt;name>
 490        &lt;/syntax>
 491        &lt;syntax type="xml" marcxml="1" stylesheet="MARC21slim2SRWDC.xsl"
 492          identifier="info:srw/schema/1/dc-v1.1">
 493          &lt;title>Dublin Core&lt;title>
 494          &lt;name>dc&lt;name>
 495        &lt;/syntax>
 496        &lt;syntax type="*" error="238"/>
 497        ..
 498        &lt;/target>
 499        &lt;/proxy>
 500       </screen>
 501     </para>
 502     </example>
 503
 504    </section>
 505
 506    <section id="proxy-config-explain">
 507     <title>explain</title>
 508     <para>
 509      The <literal>explain</literal> element includes Explain information
 510      for SRU about the server in the target section. This
 511      information must have a <literal>serverInfo</literal> element
 512      with a database that this target must be available as (URL path).
 513      For example,
 514      <screen><![CDATA[
 515       <explain xmlns="http://explain.z3950.org/dtd/2.0/">
 516         <serverInfo>
 517           <host>myhost.org</host>
 518           <port>8000</port>
 519           <database>mydatabase</database>
 520         </serverInfo>
 521         <!-- remaining Explain stuff -->
 522       </explain>
 523       ]]>
 524      </screen>
 525      In the above case, the SRU service is available as
 526      <literal>http://myhost.org:8000/mydatabase</literal>.
 527     </para>
 528
 529    </section>
 530
 531    <section id="proxy-config-cql2rpn">
 532     <title>cql2rpn</title>
 533     <para>
 534      The content of the <literal>cql2rpn</literal> element specifies
 535      the path from the working directory to a CQL-to-RPN conversion
 536      file for the server in the target section. This element
 537      is required for SRU searches to operate against Z39.50
 538      servers that don't support CQL. Most Z39.50 servers only support
 539      Type-1/RPN so this is usually required.
 540     </para>
 541     <para>
 542      See YAZ documentation for more information about the
 543      <ulink url="&url.yaz.cql2pqf;">CQL to PQF</ulink> conversion.
 544      See also the
 545      <filename>pqf.properties</filename> in the <filename>etc</filename>
 546      (or <replaceable>prefix/share/yazproxy</replaceable>)
 547      directory of the YAZ proxy distribution.
 548     </para>
 549    </section>
 550
 551    <section id="proxy-config-preinit">
 552     <title>preinit</title>
 553     <para>
 554      The element <literal>preinit</literal> is the child of element
 555      <literal>target</literal> and specifies the number of spare
 556      connection to a target. By default no spare connection are
 557      created by the proxy. If the proxy uses a target exclusive or
 558      a lot, the preinit session will ensure that target sessions
 559      have been made before the client makes a connection and will therefore
 560      reduce the connect-init handshake dramatically. Never set this to
 561      more than 5.
 562     </para>
 563    </section>
 564
 565    <section id="proxy-config-target-authentication">
 566     <title>target-authentication</title>
 567     <para>
 568      The element <literal>target-authentication</literal> specifies
 569      fixed authentication information to be sent to the backend target.
 570     </para>
 571     <para>
 572      This element takes a an attribute <literal>type</literal> which is
 573      the authenticatin type to be used..
 574     </para>
 575     <variablelist>
 576      <varlistentry><term><literal>none</literal></term>
 577       <listitem>
 578        <para>
 579         No authentication. There is no CDATA associated with this.
 580        </para>
 581       </listitem>
 582      </varlistentry>
 583
 584      <varlistentry><term><literal>anonymous</literal></term>
 585       <listitem>
 586        <para>
 587         Anonymous authentication. There is no CDATA associated with this.
 588        </para>
 589       </listitem>
 590      </varlistentry>
 591
 592      <varlistentry><term><literal>open</literal></term>
 593       <listitem>
 594        <para>
 595         Open authentication. The CDATA consists of the
 596         open authentication string.
 597        </para>
 598       </listitem>
 599      </varlistentry>
 600
 601      <varlistentry><term><literal>idPass</literal></term>
 602       <listitem>
 603        <para>
 604         IdPass authentication. The CDATA consists of
 605         three terms: user, group and password.
 606        </para>
 607       </listitem>
 608      </varlistentry>
 609     </variablelist>
 610    </section>
 611
 612    <section id="proxy-config-target-charset">
 613     <title>target-charset</title>
 614     <para>
 615      The element <literal>target-charset</literal> specifies the
 616      native character set that the target uses for queries.
 617     </para>
 618     <para>
 619      If this is specified the proxy will act as a Z39.50 server
 620      supporting character set negotiation. And in SRU mode
 621      it will convert from UTF-8 (UNICODE) to this native character
 622      set (if possible).
 623     </para>
 624    </section>
 625
 626    <section id="proxy-config-max-clients">
 627     <title>max-clients</title>
 628     <para>
 629      The element <literal>max-clients</literal> is the child of element
 630      <literal>proxy</literal> and specifies the total number of
 631      allowed connections to targets (all targets). If this limit
 632      is reached the proxy will close the least recently used connection.
 633     </para>
 634     <para>
 635      Note, that many Unix systems impose a system on the number of
 636      open files allowed in a single process, typically in the
 637      range 256 (Solaris) to 1024 (Linux).
 638      The proxy uses 2 sockets per session + a few files
 639      for logging. As a rule of thumb, ensure that 2*max-clients + 5
 640      can be opened by the proxy process.
 641     </para>
 642     <tip>
 643      <para>
 644       Using the <ulink url="&url.bash;">bash</ulink> shell, you can set
 645       the limit with
 646       <literal>ulimit -n</literal><replaceable>no</replaceable>.
 647        Use <literal>ulimit -a</literal> to display limits.
 648      </para>
 649      </tip>
 650    </section>
 651
 652    <section id="proxy-config-log">
 653     <title>log</title>
 654     <para>
 655      The element <literal>log</literal> is the child of element
 656      <literal>proxy</literal> and specifies what to be logged by the
 657      proxy.
 658      </para>
 659     <para>
 660      Specify the log file with command-line option <literal>-l</literal>.
 661     </para>
 662     <para>
 663      The text of the <literal>log</literal> element is a sequence of
 664      options separated by white space. See the table below:
 665      <table frame="top"><title>Logging options</title>
 666       <tgroup cols="2">
 667        <colspec colwidth="1*"/>
 668        <colspec colwidth="2*"/><thead>
 669         <row>
 670          <entry>Option</entry>
 671          <entry>Description</entry>
 672         </row>
 673        </thead>
 674        <tbody>
 675         <row>
 676          <entry><literal>client-apdu</literal></entry>
 677          <entry>
 678           Log APDUs as reported by YAZ for the
 679           communication between the client and the proxy.
 680           This facility is equivalent to the APDU logging that
 681           happens when using option <literal>-a</literal>, however
 682           this tells the proxy to log in the same file as given
 683           by <literal>-l</literal>.
 684          </entry>
 685         </row>
 686         <row>
 687          <entry><literal>server-apdu</literal></entry>
 688          <entry>
 689           Log APDUs as reported by YAZ for the
 690           communication between the proxy and the server (backend).
 691          </entry>
 692         </row>
 693         <row>
 694          <entry><literal>clients-requests</literal></entry>
 695          <entry>
 696           Log a brief description about requests transferred between
 697           the client and the proxy. The name of the request and the size
 698           of the APDU is logged.
 699          </entry>
 700         </row>
 701         <row>
 702          <entry><literal>server-requests</literal></entry>
 703          <entry>
 704           Log a brief description about requests transferred between
 705           the proxy and the server (backend). The name of the request
 706           and the size of the APDU is logged.
 707          </entry>
 708         </row>
 709         <row>
 710          <entry><literal>client-ip</literal></entry>
 711          <entry>
 712           Log the client IP for each log entry. By default, the client IP
 713           is only logged when a new session starts.
 714          </entry>
 715         </row>
 716        </tbody>
 717       </tgroup>
 718      </table>
 719     </para>
 720     <para>
 721      To log communication in details between the proxy and the backend, th
 722      following configuration could be used:
 723      <screen><![CDATA[
 724       <target name="mytarget">
 725        <log>server-apdu server-requests</log>
 726       </target>
 727       ]]>
 728      </screen>
 729     </para>
 730    </section>
 731
 732    <section id="proxy-max-connect">
 733     <title>max-connect</title>
 734     <para>
 735      The element <literal>max-connect</literal> is a child of element
 736      <literal>proxy</literal> and specifies the maximum number
 737      of connections to be initiated within the last minute (or
 738      value of <link linkend="proxy-period-connect">period-connect</link>.
 739     </para>
 740     <para>
 741      If the maximum number is reached the proxy will terminate the
 742      just initiated session (connection terminated).
 743     </para>
 744    </section>
 745
 746    <section id="proxy-limit-connect">
 747     <title>limit-connect</title>
 748     <para>
 749      The element <literal>max-connect</literal> is a child of element
 750      <literal>proxy</literal> and specifies the limit of number
 751      of connections to be initiated within the last minute (or
 752      value of <link linkend="proxy-period-connect">period-connect</link>.
 753     </para>
 754     <para>
 755      If the maximum number is reached the proxy delays the first operation
 756      in the session by one second.
 757     </para>
 758    </section>
 759
 760    <section id="proxy-period-connect">
 761     <title>period-connect</title>
 762     <para>
 763      The element <literal>period-connect</literal> is a child of element
 764      <literal>proxy</literal> and specifies period - in the number of seconds
 765      that <link linkend="proxy-limit-connect">limit-connect</link> and
 766      <link linkend="proxy-max-connect">max-connect</link>
 767      should measure connections.
 768     </para>
 769     <para>
 770      If <literal>period-connect</literal> is omitted, 60 seconds is used.
 771     </para>
 772    </section>
 773
 774    <section id="proxy-docpath">
 775     <title>docpath</title>
 776     <para>
 777      The element <literal>docpath</literal> is a child of element
 778      <literal>proxy</literal> and specifies an allowed HTTP path
 779      for local file access. Using <literal>docpath</literal> the
 780      proxy may return static file content.
 781     </para>
 782     <para>
 783      The value of docpath both serves as a HTTP path prefix
 784      <emphasis>and</emphasis> as a local file prefix.
 785      If a value of <literal>etc</literal> is used only URLs with the
 786      prefix <literal>/etc/</literal> results in a local file access to the
 787      directory <literal>etc</literal> within the working directory
 788      of yazproxy.
 789     </para>
 790     <note>
 791     <para>
 792       Care has been taken to ensure that hostile URLs are rejected - including
 793       strings such as <literal>..</literal> and <literal>/</literal> (absolute
 794       file system access).
 795      </para>
 796     </note>
 797    </section>
 798
 799   </section>
 800   <section id="proxy-usage">
 801    <title>Proxy Manual Pages</title>
 802    <refentry id="yazproxy-man">
 803     &yaz-proxy-ref;
 804    </refentry>
 805   </section>
 806
 807   <section id="otherinfo-encoding">
 808    <title>OtherInformation Encoding</title>
 809    <para>
 810     The proxy uses the OtherInformation definition to carry
 811     information about the target address and cookie.
 812    </para>
 813    <screen>
 814   OtherInformation   ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
 815     category           [1]   IMPLICIT InfoCategory OPTIONAL,
 816     information        CHOICE{
 817       characterInfo            [2]  IMPLICIT InternationalString,
 818       binaryInfo               [3]  IMPLICIT OCTET STRING,
 819       externallyDefinedInfo    [4]  IMPLICIT EXTERNAL,
 820       oid                      [5]  IMPLICIT OBJECT IDENTIFIER}}
 821 --
 822   InfoCategory ::= SEQUENCE{
 823       categoryTypeId   [1]   IMPLICIT OBJECT IDENTIFIER OPTIONAL,
 824       categoryValue    [2]   IMPLICIT INTEGER}
 825   </screen>
 826    <para>
 827     The <literal>categoryTypeId</literal> is either
 828     OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
 829     for proxy target and proxy cookie respectively. The
 830     <literal>categoryValue</literal> is set to 1.
 831     The value proxy and cookie is stored in element
 832     <literal>characterInfo</literal> of the <literal>information</literal>
 833      choice.
 834    </para>
 835   </section>
 836   <section id="yazproxy-schema">
 837    <title>YAZ Proxy Configuration Schema</title>
 838    <para>
 839     Here an XML Schema for the YAZ proxy configuration file.
 840     The schema, <filename>yazproxy.xsd</filename> is located in sub
 841     directory <filename>etc</filename> of the distribution.
 842    </para>
 843    <screen><![CDATA[
 844 <?xml version="1.0"?>
 845 <!-- XML Schema for YAZ proxy config file.
 846 -->
 847 <xs:schema
 848   xmlns:xs="http://www.w3.org/2001/XMLSchema"
 849   xmlns:exp="http://explain.z3950.org/dtd/2.0/"
 850   xmlns="http://indexdata.dk/yazproxy/schema/0.9/"
 851   targetNamespace="http://indexdata.dk/yazproxy/schema/0.9/"
 852   >
 853  <xs:import namespace="http://explain.z3950.org/dtd/2.0/"
 854       schemaLocation="zeerex-2.0.xsd"/>
 855  <xs:element name="proxy">
 856   <xs:complexType>
 857    <xs:sequence>
 858     <xs:element ref="target" minOccurs="0" maxOccurs="unbounded"/>
 859     <xs:element ref="max-clients" minOccurs="0"/>
 860     <xs:element ref="log" minOccurs="0"/>
 861     <xs:element ref="module" minOccurs="0"/>
 862    </xs:sequence>
 863   </xs:complexType>
 864  </xs:element>
 865
 866  <xs:element name="target">
 867   <xs:complexType>
 868    <xs:sequence>
 869      <xs:element ref="url" minOccurs="0" maxOccurs="unbounded"/>
 870      <xs:element ref="target-timeout" minOccurs="0"/>
 871      <xs:element ref="client-timeout" minOccurs="0"/>
 872      <xs:element ref="max-sockets" minOccurs="0"/>
 873      <xs:element ref="keepalive" minOccurs="0"/>
 874      <xs:element ref="limit" minOccurs="0"/>
 875      <xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded"/>
 876      <xs:element ref="syntax" minOccurs="0" maxOccurs="unbounded"/>
 877      <xs:element ref="preinit" minOccurs="0"/>
 878      <xs:element ref="exp:explain" minOccurs="0"/>
 879      <xs:element ref="cql2rpn" minOccurs="0"/>
 880      <xs:element ref="target-authentication" minOccurs="0"/>
 881      <xs:element ref="client-authentication" minOccurs="0"/>
 882      <xs:element ref="negotiation-charset" minOccurs="0"/>
 883      <xs:element ref="negotiation-lang" minOccurs="0"/>
 884    </xs:sequence>
 885    <xs:attribute name="default" type="xs:string" use="optional"/>
 886    <xs:attribute name="name" type="xs:string"/>
 887    <xs:attribute name="database" type="xs:string"/>
 888   </xs:complexType>
 889  </xs:element>
 890
 891  <xs:element name="url" type="xs:string"/>
 892  <xs:element name="target-timeout" type="xs:integer"/>
 893  <xs:element name="client-timeout" type="xs:integer"/>
 894  <xs:element name="max-sockets" type="xs:integer"/>
 895  <xs:element name="bandwidth" type="xs:integer"/>
 896  <xs:element name="pdu" type="xs:integer"/>
 897  <xs:element name="retrieve" type="xs:integer"/>
 898  <xs:element name="preinit" type="xs:integer"/>
 899  <xs:element name="cql2rpn" type="xs:string"/>
 900  <xs:element name="target-authentication">
 901    <xs:complexType>
 902     <xs:simpleContent>
 903       <xs:extension base="xs:string">
 904         <xs:attribute name="type" type="xs:string"/>
 905       </xs:extension>
 906     </xs:simpleContent>
 907    </xs:complexType>
 908  </xs:element>
 909
 910  <xs:element name="client-authentication">
 911    <xs:complexType>
 912     <xs:simpleContent>
 913       <xs:extension base="xs:string">
 914         <xs:attribute name="module" type="xs:string"/>
 915         <xs:attribute name="args" type="xs:string"/>
 916       </xs:extension>
 917     </xs:simpleContent>
 918    </xs:complexType>
 919  </xs:element>
 920
 921  <xs:element name="negotiation-charset" type="xs:string"/>
 922  <xs:element name="negotiation-lang" type="xs:string"/>
 923
 924  <xs:element name="keepalive">
 925   <xs:complexType>
 926    <xs:sequence>
 927     <xs:element ref="bandwidth" minOccurs="0"/>
 928     <xs:element ref="pdu" minOccurs="0"/>
 929    </xs:sequence>
 930   </xs:complexType>
 931  </xs:element>
 932  <xs:element name="limit">
 933   <xs:complexType>
 934    <xs:sequence>
 935     <xs:element ref="bandwidth" minOccurs="0"/>
 936     <xs:element ref="pdu" minOccurs="0"/>
 937     <xs:element ref="retrieve" minOccurs="0"/>
 938    </xs:sequence>
 939   </xs:complexType>
 940  </xs:element>
 941
 942  <xs:element name="attribute">
 943   <xs:complexType>
 944    <xs:attribute name="type" type="xs:string"/>
 945    <xs:attribute name="value" type="xs:string"/>
 946    <xs:attribute name="error" type="xs:integer"/>
 947   </xs:complexType>
 948  </xs:element>
 949
 950  <xs:element name="syntax">
 951   <xs:complexType>
 952    <xs:sequence>
 953     <xs:element ref="title" minOccurs="0"/>
 954     <xs:element ref="name" minOccurs="0" maxOccurs="unbounded"/>
 955    </xs:sequence>
 956    <xs:attribute name="error" type="xs:string" />
 957    <xs:attribute name="type" type="xs:string" />
 958    <xs:attribute name="marcxml" type="xs:string" />
 959    <xs:attribute name="identifier" type="xs:string" />
 960    <xs:attribute name="stylesheet" type="xs:string" />
 961    <xs:attribute name="backendtype" type="xs:string" />
 962    <xs:attribute name="backendcharset" type="xs:string" />
 963    <xs:attribute name="usemarconstage1" type="xs:string" />
 964    <xs:attribute name="usemarconstage2" type="xs:string" />
 965   </xs:complexType>
 966  </xs:element>
 967
 968  <xs:element name="title" type="xs:string"/>
 969  <xs:element name="name" type="xs:string"/>
 970
 971  <xs:element name="max-clients" type="xs:integer"/>
 972  <xs:element name="log" type="xs:string"/>
 973  <xs:element name="module" type="xs:string"/>
 974
 975 </xs:schema>
 976 ]]>
 977    </screen>
 978   </section>
 979  </chapter>
 980
 981  <!-- Keep this comment at the end of the file
 982  Local variables:
 983  mode: sgml
 984  sgml-omittag:t
 985  sgml-shorttag:t
 986  sgml-minimize-attributes:nil
 987  sgml-always-quote-attributes:t
 988  sgml-indent-step:1
 989  sgml-indent-data:t
 990  sgml-parent-document: "yazproxy.xml"
 991  sgml-local-catalogs: nil
 992  sgml-namecase-general:t
 993  End:
 994  -->
 995