doc/proxy.xml

   1  <chapter id="proxy">
   2   <title>The YAZ Proxy</title>
   3   <para>
   4    The YAZ proxy is a transparent Z39.50-to-Z39.50 gateway.  That is,
   5    it is a Z39.50 server which has as its back-end a Z39.50 client
   6    that forwards requests on to another server (known as the
   7    <firstterm>backend target</firstterm>.)
   8   </para>
   9   <para>
  10    The YAZ Proxy is useful for debugging Z39.50 software, logging
  11    APDUs, redirecting Z39.50 packages through firewalls, etc.
  12    Furthermore, it offers facilities that often
  13    boost performance for connectionless Z39.50 clients such
  14    as web gateways.
  15   </para>
  16   <para>
  17    Unlike most other server software, the proxy runs single-threaded,
  18    single-process. Every I/O operation
  19    is non-blocking so it is very lightweight and extremely fast.
  20    It does not store any state information on the hard drive,
  21    except any log files you ask for.
  22   </para>
  23
  24   <section id="proxy-example">
  25    <title>Example: Using the Proxy to Log APDUs</title>
  26    <para>
  27     Suppose you use a commercial Z39.50 client for which you do not
  28     have source code, and it's not behaving how you think it should
  29     when running against some specific server that you have no control
  30     over.  One way to diagnose the problem is to find out what packets
  31     (APDUs) are being sent and received, but not all client
  32     applications have facilities to do APDU logging.
  33    </para>
  34    <para>
  35     No problem.  Run the proxy on a friendly machine, get it to log
  36     APDUs, and point the errant client at the proxy instead of
  37     directly at the server that's causing it problems.
  38    </para>
  39    <para>
  40     Suppose the server is running on <literal>foo.bar.com</literal>,
  41     port 18398.  Run the proxy on the machine of your choice, say
  42     <literal>your.company.com</literal> like this:
  43    </para>
  44    <screen>
  45     yaz-proxy -a - -t tcp:foo.bar.com:18398 tcp:@:9000
  46    </screen>
  47    <para>
  48     (The <literal>-a -</literal> option requests APDU logging on
  49     standard output, <literal>-t tcp:foo.bar.com:18398</literal>
  50     specifies where the backend target is, and
  51     <literal>tcp:@:9000</literal> tells the proxy to listen on port
  52     9000 and accept connections from any machine.)
  53    </para>
  54    <para>
  55     Now change your client application's configuration so that instead
  56     of connecting to <literal>foo.bar.com</literal> port 18398, it
  57     connects to <literal>your.company.com</literal> port 9000, and
  58     start it up.  It will work exactly as usual, but all the packets
  59     will be sent via the proxy, which will generate a log like this:
  60    </para>
  61    <screen>
  62     decode choice
  63     initRequest {
  64         referenceId OCTETSTRING(len=4) 69 6E 69 74
  65         protocolVersion BITSTRING(len=1)
  66         options BITSTRING(len=2)
  67         preferredMessageSize 1048576
  68         maximumRecordSize 1048576
  69         implementationId 'Mike Taylor (id=169)'
  70         implementationName 'Net::Z3950.pm (Perl)'
  71         implementationVersion '0.31'
  72     }
  73     encode choice
  74     initResponse {
  75         referenceId OCTETSTRING(len=4) 69 6E 69 74
  76         protocolVersion BITSTRING(len=1)
  77         options BITSTRING(len=2)
  78         preferredMessageSize 1048576
  79         maximumRecordSize 1048576
  80         result TRUE
  81         implementationId '81'
  82         implementationName 'GFS/YAZ / Zebra Information Server'
  83         implementationVersion 'YAZ 1.9.1 / Zebra 1.3.3'
  84     }
  85     decode choice
  86     searchRequest {
  87         referenceId OCTETSTRING(len=1) 30
  88         smallSetUpperBound 0
  89         largeSetLowerBound 1
  90         mediumSetPresentNumber 0
  91         replaceIndicator TRUE
  92         resultSetName 'default'
  93         databaseNames {
  94             'gils'
  95         }
  96         {
  97             smallSetElementSetNames choice
  98             generic 'F'
  99         }
 100         {
 101             mediumSetElementSetNames choice
 102             generic 'B'
 103         }
 104         preferredRecordSyntax OID: 1 2 840 10003 5 10
 105         {
 106             query choice
 107             type_1 {
 108                 attributeSetId OID: 1 2 840 10003 3 1
 109                 RPNStructure choice
 110                 {
 111                     simple choice
 112                     attributesPlusTerm {
 113                         attributes {
 114                         }
 115                         term choice
 116                         general OCTETSTRING(len=7) 6D 69 6E 65 72 61 6C
 117                     }
 118                 }
 119             }
 120         }
 121     }
 122    </screen>
 123   </section>
 124
 125   <section id="proxy-target">
 126    <title>Specifying the Backend Target</title>
 127    <para>
 128     When the proxy accepts a Z39.50 client session, it
 129     determines the backend target by the following rules:
 130     <orderedlist>
 131      <listitem>
 132       <para> If the <literal>InitializeRequest</literal> PDU from the
 133        client includes an
 134        <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
 135        element with OID
 136        <literal>1.2.840.10003.10.1000.81.1</literal>, then the
 137        contents of that element specify the target to be used, in the
 138        usual YAZ address format (typically
 139        <literal>tcp:<parameter>hostname</parameter>:<parameter>port</parameter></literal>)
 140        as described in
 141        <ulink url="http://www.indexdata.dk/yaz/doc/comstack.addresses.php"
 142         >the Addresses section of the YAZ manual</ulink>.
 143       </para>
 144      </listitem>
 145      <listitem>
 146       <para> Otherwise, the Proxy uses the default target, if one was
 147        specified on the command-line with the <literal>-t</literal>
 148        option. A default target can also be specified in the
 149        XML Config file.
 150       </para>
 151      </listitem>
 152      <listitem>
 153       <para> Otherwise, the proxy closes the connection with
 154        the client.
 155       </para>
 156      </listitem>
 157     </orderedlist>
 158    </para>
 159   </section>
 160   <section id="proxy-keepalive">
 161    <title>Keep-alive Facility</title>
 162    <para>
 163     The keep-alive is a facility where the proxy keeps the connection to the
 164     backend - even if the client closes the connection to the proxy.
 165    </para>
 166    <para>
 167     If a new or another client connects to the proxy again and requests the
 168     same backend it will be reassigned to this backend. In this case, the
 169     proxy sends an initialize response directly to the client and an
 170     initialize handshake with the backend is omitted.
 171    </para>
 172    <para>
 173     When a client reconnects, query and record caching works better, if the
 174     proxy assigns it to the same backend as before. And the result set
 175     (if any) is re-used. To achive this, Index Data defined a session
 176     cookie which identifies the backend session.
 177    </para>
 178    <para>
 179     The cookie is defined by the client and is sent as part of the
 180     Initialize Request and passed in an
 181     <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
 182     element with OID <literal>1.2.840.10003.10.1000.81.2</literal>.
 183    </para>
 184    <para>
 185     Clients that do not send a cookie as part of the initialize request
 186     may still better performance, since the init handshake is saved.
 187    </para>
 188   </section>
 189
 190   <section id="query-cache">
 191    <title>Query Caching</title>
 192    <para>
 193     Simple stateless clients often send identical Z39.50 searches
 194     in a relatively short period of time (e.g. in order to produce a
 195     results-list page, the next page,
 196     a single full-record, etc). And for many targets, it's
 197     much more expensive to produce a new result set than to
 198     reuse an existing one.
 199    </para>
 200    <para>
 201     The proxy tries to solve that by remembering the last query for each
 202     backend target, so that if an identical query is received next, it
 203     is turned into Present Requests rather than new Search Requests.
 204    </para>
 205    <note>
 206     <para>
 207      In a future we release will will probably allows for
 208      an arbitrary-sized cache for targets supporting named result sets.
 209     </para>
 210    </note>
 211    <para>
 212     You can enable/disable query caching using option -o.
 213    </para>
 214   </section>
 215
 216   <section id="record-cache">
 217    <title>Record Caching</title>
 218    <para>
 219     As an option, the proxy may also cache result set records for the
 220     last search.
 221     The proxy takes into account the Record Syntax and CompSpec.
 222     The CompSpec includes simple element set names as well.
 223     By default the cache is 200000 bytes per session.
 224    </para>
 225   </section>
 226
 227   <section id="query-validation">
 228    <title>Query Validation</title>
 229    <para>
 230     The Proxy may also be configured to trap particular attributes in
 231     Type-1 queries and send Bib-1 diagnostics back to the client without
 232     even consulting the backend target. This facility may be useful if
 233     a target does not properly issue diagnostics when unsupported attributes
 234     are send to it.
 235    </para>
 236   </section>
 237
 238   <section id="record-validation">
 239    <title>Record Syntax Validation</title>
 240    <para>
 241     The proxy may be configured to accept, reject or convert records.
 242     When accepted, the target passes search/present requests to the
 243     backend target under the assumption that the target can honor the
 244     request (In fact it may not do that). When a record is rejected because
 245     the record syntax is "unsupported" the proxy returns a diagnostic to the
 246     client. Finally, the proxy may convert records.
 247    </para>
 248    <para>
 249     In the current version the only supported conversion is
 250     MARC21/USMARC in MARC-8 charset to MARCXML in UTF-8. Future version of
 251     the proxy may do other record/charset conversions.
 252    </para>
 253   </section>
 254
 255   <section id="other-optimizations">
 256    <title>Other Optimizations</title>
 257    <para>
 258     We've had some plans to support global caching of result set records,
 259     but this has not yet been implemented.
 260    </para>
 261   </section>
 262
 263   <section id="proxy-config-file">
 264    <title>Proxy Configuration File</title>
 265    <para>
 266     The Proxy as an option may read a configuration file using option
 267     <literal>-c</literal> followed by the filename of a config file.
 268     </para>
 269    <para>
 270     The config file is in XML format. The YAZ proxy must be compiled
 271     with <ulink url="http://www.xmlsoft.org/">libxml2</ulink> support in
 272     order for the config file facility to be enabled.
 273    </para>
 274    <tip>
 275     <para>To check for a config file to be well-formed, the yaz-proxy may
 276      be invoked without specifying a listening port, i.e.
 277      <screen>
 278       yaz-proxy -c myconfig.xml
 279      </screen>
 280      If this does not produce errors, the file is well-formed.
 281     </para>
 282    </tip>
 283    <section id="proxy-config-header">
 284     <title>Proxy Configuration Header</title>
 285     <para>
 286      The proxy config file must have a root element called
 287      <literal>proxy</literal>. All information except an optional XML
 288      header must be stored within the <literal>proxy</literal> element.
 289     </para>
 290     <screen>
 291      &lt;?xml version="1.0"?>
 292      &lt;proxy>
 293       &lt;!-- content here .. -->
 294      &lt;/proxy>
 295     </screen>
 296     </section>
 297    <section id="proxy-config-target">
 298     <title>Configuration: target</title>
 299     <para>
 300      The element <literal>target</literal> which may be repeated zero
 301      or more times with parent elemtn <literal>proxy</literal> contains
 302      information about each backend target.
 303      The <literal>target</literal> element have two attributes:
 304      <literal>name</literal> which holds the logical name of the backend
 305      target (required) and <literal>default</literal> (optional) which
 306      (when given) specifies that the backend target is the default target -
 307      equivalent to command line option <literal>-t</literal>.
 308     </para>
 309     <para>
 310      <screen>
 311      &lt;?xml version="1.0"?>
 312      &lt;!-- $Id -->
 313      &lt;proxy>
 314       &lt;target name="server1" default="1">
 315        &lt;!-- description of server1 .. -->
 316       &lt;/target>
 317       &lt;target name="server2">
 318        &lt;!-- description of server2 .. -->
 319       &lt;/target>
 320      &lt;/proxy>
 321      </screen>
 322     </para>
 323    </section>
 324    <section id="proxy-config-url">
 325     <title>Configuration:url</title>
 326     <para>
 327      The <literal>url</literal> which may be repeated one or more times
 328      should be the child of the <literal>target</literal> element.
 329      The CDATA of <literal>url</literal> is the Z-URL of the backend.
 330     </para>
 331     <para>
 332      Multiple <literal>url</literal> element may be used. In that case, then
 333      a client initiates a session, the proxy chooses the URL with the lowest
 334      number of active sessions, thereby distributing the load. It is
 335      assumed that each URL represents the same database (data).
 336     </para>
 337    </section>
 338    <section id="proxy-config-keepalive">
 339     <title>Configuration: keepalive</title>
 340     <para>The <literal>keepalive</literal> element holds information about
 341      the keepalive Z39.50 sessions. Keepalive sessions are proxy-to-backend
 342      sessions that is no longer associated with a client session.
 343     </para>
 344     <para>The <literal>keepalive</literal> element which is the child of
 345      the <literal>target</literal>holds two elements:
 346      <literal>bandwidth</literal> and <literal>pdu</literal>.
 347      The <literal>bandwidth</literal> is the maximum total bytes
 348      transferred to/from the target. If a target session exceeds this
 349      limit, it is shut down (and no longer kept alive).
 350      The <literal>pdu</literal> is the maximum number of requests sent
 351      to the target. If a target session exceeds this limit, it is
 352      shut down. The idea of these two limits is that avoid very long
 353      sessions that use resources in a backend (that leaks!).
 354     </para>
 355     <para>
 356      The following sets maximum number of bytes transferred in a
 357      target session to 1 MB and maxinum of requests to 400.
 358      <screen>
 359       &lt;keepalive>
 360        &lt;bandwidth>1048576&lt;/bandwidth>
 361        &lt;retrieve>400&lt;/retrieve>
 362       &lt;/keepalive>
 363      </screen>
 364     </para>
 365    </section>
 366    <section id="proxy-config-limit">
 367     <title>Configuration: limit</title>
 368     <para>
 369      The <literal>limit</literal> section specifies bandwidth/pdu requests
 370      limits for an active session.
 371      The proxy records bandwidth/pdu requests during the last 60 seconds
 372      (1 minute). The <literal>limit</literal> may include the
 373      elements <literal>bandwidth</literal>, <literal>pdu</literal>,
 374      and <literal>retrieve</literal>. The <literal>bandwidth</literal>
 375      measures the number of bytes transferred within the last minute.
 376      The <literal>pdu</literal> is the number of requests in the last
 377      minute. The <literal>retrieve</literal> holds the maximum records to
 378      be retrived in one Present Request.
 379     </para>
 380     <para>
 381      If a bandwidth/pdu limit is reached the proxy will postpone the
 382      requests to the target and wait one or more seconds. The idea of the
 383      limit is to ensure that clients that downloads hundreds or thousands of
 384      records do not hurt other users.
 385     </para>
 386     <para>
 387      The following sets maximum number of bytes transferred per minute to
 388      500Kbytes and maximum number of requests to 40.
 389      <screen>
 390       &lt;limit>
 391        &lt;bandwidth>524288&lt;/bandwidth>
 392        &lt;retrieve>40&lt;/retrieve>
 393       &lt;/limit>
 394      </screen>
 395     </para>
 396     <note>
 397      <para>
 398       Typically the limits for keepalive are much higher than
 399       those for session minute average.
 400      </para>
 401     </note>
 402    </section>
 403
 404    <section id="proxy-config-attribute">
 405     <title>Configuration: attribute</title>
 406     <para>
 407      The <literal>attribute</literal> element specifies accept or reject
 408      or a particular attribute type, value pair.
 409      Well-behaving targets will reject unsupported attributes on their
 410      own. This feature is useful for targets that do not gracefully
 411      handle unsupported attributes.
 412     </para>
 413     <para>
 414      Attribute elements may be repeated. The proxy inspects the attribute
 415      specifications in the order as specified in the configuration file.
 416      When a given attribute specification matches a given attribute list
 417      in a query, the proxy takes appropriate action (reject, accept).
 418     </para>
 419     <para>
 420      If no attribute specifications matches the attribute list in a query,
 421      it is accepted.
 422     </para>
 423     <para>
 424      The <literal>attribute</literal> element has two required attributes:
 425      <literal>type</literal> which is the Attribute Type-1 type, and
 426      <literal>value</literal> which is the Attribute Type-1 value.
 427      The special value/type <literal>*</literal> matches any attribute
 428      type/value. A value may also be specified as a list with each
 429      value separated by comma, a value may also be specified as a
 430      list: low value - dash - high value.
 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      type, value is part of a query.
 436     </para>
 437     <para>
 438      If attribute <literal>error</literal> is not given, the attribute
 439      type, value is accepted and passed to the backend target.
 440     </para>
 441     <para>
 442      A target that supports use attributes 1,4, 1000 through 1003 and
 443      no other use attributes, could use the following rules:
 444      <screen>
 445       &lt;attribute type="1" value="1,4,1000-1003">
 446       &lt;attribute type="1" value="*" error="114"/>
 447      </screen>
 448     </para>
 449    </section>
 450
 451    <section id="proxy-config-syntax">
 452     <title>Configuration: syntax</title>
 453     <para>
 454      The <literal>syntax</literal> element specifies accept or reject
 455      or a particular record syntax request from the client.
 456     </para>
 457     <para>
 458      The <literal>syntax</literal> has one equired attribute:
 459      <literal>type</literal> which is the Preferred Record Syntax.
 460     </para>
 461     <para>
 462      If attribute <literal>error</literal> is given, that holds a
 463      Bib-1 diagnostic which is sent to the client if the particular
 464      record syntax is part of a present - or search request.
 465     </para>
 466     <para>
 467      If attribute <literal>error</literal> is not given, the record syntax
 468      is accepted and passed to the backend target.
 469     </para>
 470     <para>
 471      If attribute <literal>marcxml</literal> is given, the proxy will
 472      perform MARC21 to MARCXML conversion. In this case the
 473      <literal>type</literal> should be XML. The proxy will use
 474      preferred record syntax USMARC/MARC21 against the backend target.
 475     </para>
 476     <para>To accept USMARC and offer MARCXML XML recors but reject
 477      all other requests the following configuaration could be used:
 478      <screen>
 479       &lt;proxy>
 480        &lt;target name="mytarget">
 481         &lt;syntax type="usmarc"/>
 482         &lt;syntax type="xml" marcxml="1"/>
 483         &lt;syntax type="*" error="238"/>
 484        &lt;/target>
 485       &lt;/proxy>
 486      </screen>
 487     </para>
 488    </section>
 489
 490    <section id="proxy-config-target-timeout">
 491     <title>Configuration: target-timeout</title>
 492     <para>
 493      The element <literal>target-timeout</literal> is the child of element
 494      <literal>target</literal> and specifies the amount in seconds before
 495      a target session is shut down.
 496     </para>
 497     <para>
 498      This can also be specified on the command line bt using option
 499      <literal>-T</literal>. Refer to <xref linkend="proxy-usage"/>.
 500     </para>
 501    </section>
 502
 503    <section id="proxy-config-client-timeout">
 504     <title>Configuration: client-timeout</title>
 505     <para>
 506      The element <literal>client-timeout</literal> is the child of element
 507      <literal>target</literal> and specifies the amount in seconds before
 508      a client session is shut down.
 509      </para>
 510     <para>
 511      This can also be specified on the command line by using option
 512      <literal>-i</literal>. Refer to <xref linkend="proxy-usage"/>.
 513     </para>
 514    </section>
 515
 516    <section id="proxy-config-preinit">
 517     <title>Configuration: preinit</title>
 518     <para>
 519      The element <literal>preinit</literal> is the child of element
 520      <literal>target</literal> and specifies the number of spare
 521      connection to a target. By default no spare connection are
 522      created by the proxy. If the proxy uses a target exclusive or
 523      a lot, the preinit session will ensure that target sessions
 524      have been made before the client makes a connection and will therefore
 525      reduce the connect-init handshake dramatically. Never set this to
 526      more than 5.
 527     </para>
 528    </section>
 529
 530    <section id="proxy-config-max-clients">
 531     <title>Configuration: max-clients</title>
 532     <para>
 533      The element <literal>max-clients</literal> is the child of element
 534      <literal>proxy</literal> and specifies the total number of
 535      allowed connections to targets (all targets). If this limit
 536      is reached the proxy will close the least recently used connection.
 537     </para>
 538     <para>
 539      Note, that many Unix systems impose a system on the number of
 540      open files allowed in a single process, typically in the
 541      range 256 (Solaris) to 1024 (Linux).
 542      The proxy uses 2 sockets per session + a few files
 543      for logging. As a rule of thumb, ensure that 2*max-clients + 5
 544      can be opened by the proxy process.
 545     </para>
 546     <tip>
 547      <para>
 548       Using the <ulink url="http://www.gnu.org/software/bash/bash.html">
 549        bash</ulink> shell, you can set the limit with
 550       <literal>ulimit -n</literal><replaceable>no</replaceable>.
 551        Use <literal>ulimit -a</literal> to display limits.
 552      </para>
 553      </tip>
 554    </section>
 555
 556   </section>
 557   <section id="proxy-usage">
 558    <title>Proxy Usage</title>
 559    <para>
 560    </para>
 561    <refentry id="yaz-proxy">
 562     &yaz-proxy-ref;
 563    </refentry>
 564   </section>
 565   <section id="otherinfo-encoding"><title>OtherInformation Encoding</title>
 566    <para>
 567     The proxy uses the OtherInformation definition to carry
 568     information about the target address and cookie.
 569    </para>
 570    <screen>
 571   OtherInformation   ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
 572     category           [1]   IMPLICIT InfoCategory OPTIONAL,
 573     information        CHOICE{
 574       characterInfo            [2]  IMPLICIT InternationalString,
 575       binaryInfo               [3]  IMPLICIT OCTET STRING,
 576       externallyDefinedInfo    [4]  IMPLICIT EXTERNAL,
 577       oid                      [5]  IMPLICIT OBJECT IDENTIFIER}}
 578 --
 579   InfoCategory ::= SEQUENCE{
 580       categoryTypeId   [1]   IMPLICIT OBJECT IDENTIFIER OPTIONAL,
 581       categoryValue    [2]   IMPLICIT INTEGER}
 582   </screen>
 583    <para>
 584      The <literal>categoryTypeId</literal> is either
 585      OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
 586      for proxy target and proxy cookie respectively. The
 587      integer element <literal>category</literal> is set to 0.
 588      The value proxy and cookie is stored in element
 589      <literal>characterInfo</literal> of the <literal>information</literal>
 590      choice.
 591     </para>
 592    </section>
 593  </chapter>
 594  <!-- Keep this comment at the end of the file
 595  Local variables:
 596  mode: sgml
 597  sgml-omittag:t
 598  sgml-shorttag:t
 599  sgml-minimize-attributes:nil
 600  sgml-always-quote-attributes:t
 601  sgml-indent-step:1
 602  sgml-indent-data:t
 603  sgml-parent-document: "yaz++.xml"
 604  sgml-local-catalogs: nil
 605  sgml-namecase-general:t
 606  End:
 607  -->
 608