Logging options may be configured in config file
[yazpp-moved-to-github.git] / 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><![CDATA[
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 ]]>
123    </screen>
124   </section>
125   
126   <section id="proxy-target">
127    <title>Specifying the Backend Target</title>
128    <para>
129     When the proxy accepts a Z39.50 client session, it
130     determines the backend target by the following rules:
131     <orderedlist>
132      <listitem>
133       <para> If the <literal>InitializeRequest</literal> PDU from the
134        client includes an 
135        <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
136        element with OID
137        <literal>1.2.840.10003.10.1000.81.1</literal>, then the
138        contents of that element specify the target to be used, in the
139        usual YAZ address format (typically
140        <literal>tcp:<parameter>hostname</parameter>:<parameter>port</parameter></literal>)
141        as described in
142        <ulink url="http://www.indexdata.dk/yaz/doc/comstack.addresses.php"
143         >the Addresses section of the YAZ manual</ulink>.
144       </para>
145      </listitem>
146      <listitem>
147       <para> Otherwise, the Proxy uses the default target, if one was
148        specified on the command-line with the <literal>-t</literal>
149        option. A default target can also be specified in the 
150        XML Config file.
151       </para>
152      </listitem>
153      <listitem>
154       <para> Otherwise, the proxy closes the connection with
155        the client.
156       </para>
157      </listitem>
158     </orderedlist>
159    </para>
160   </section>
161   <section id="proxy-keepalive">
162    <title>Keep-alive Facility</title>
163    <para>
164     The keep-alive is a facility where the proxy keeps the connection to the
165     backend - even if the client closes the connection to the proxy.
166    </para>
167    <para>
168     If a new or another client connects to the proxy again and requests the
169     same backend it will be reassigned to this backend. In this case, the
170     proxy sends an initialize response directly to the client and an
171     initialize handshake with the backend is omitted.
172    </para>
173    <para>
174     When a client reconnects, query and record caching works better, if the
175     proxy assigns it to the same backend as before. And the result set
176     (if any) is re-used. To achive this, Index Data defined a session
177     cookie which identifies the backend session.
178    </para>
179    <para>
180     The cookie is defined by the client and is sent as part of the
181     Initialize Request and passed in an
182     <link linkend="otherinfo-encoding"><literal>otherInfo</literal></link>
183     element with OID <literal>1.2.840.10003.10.1000.81.2</literal>.
184    </para>
185    <para>
186     Clients that do not send a cookie as part of the initialize request
187     may still better performance, since the init handshake is saved.
188    </para>
189   </section>
190   
191   <section id="query-cache">
192    <title>Query Caching</title>
193    <para>
194     Simple stateless clients often send identical Z39.50 searches
195     in a relatively short period of time (e.g. in order to produce a
196     results-list page, the next page,
197     a single full-record, etc). And for many targets, it's
198     much more expensive to produce a new result set than to
199     reuse an existing one.
200    </para>
201    <para>
202     The proxy tries to solve that by remembering the last query for each
203     backend target, so that if an identical query is received next, it
204     is turned into Present Requests rather than new Search Requests.
205    </para>
206    <note>
207     <para>
208      In a future we release will will probably allows for
209      an arbitrary-sized cache for targets supporting named result sets.
210     </para>
211    </note>
212    <para>
213     You can enable/disable query caching using option -o.
214    </para>
215   </section>
216   
217   <section id="record-cache">
218    <title>Record Caching</title>
219    <para>
220     As an option, the proxy may also cache result set records for the
221     last search.
222     The proxy takes into account the Record Syntax and CompSpec.
223     The CompSpec includes simple element set names as well.
224     By default the cache is 200000 bytes per session.
225    </para>
226   </section>
227   
228   <section id="query-validation">
229    <title>Query Validation</title>
230    <para>
231     The Proxy may also be configured to trap particular attributes in
232     Type-1 queries and send Bib-1 diagnostics back to the client without
233     even consulting the backend target. This facility may be useful if
234     a target does not properly issue diagnostics when unsupported attributes
235     are send to it.
236    </para>
237   </section>
238   
239   <section id="record-validation">
240    <title>Record Syntax Validation</title>
241    <para>
242     The proxy may be configured to accept, reject or convert records.
243     When accepted, the target passes search/present requests to the
244     backend target under the assumption that the target can honor the
245     request (In fact it may not do that). When a record is rejected because
246     the record syntax is "unsupported" the proxy returns a diagnostic to the
247     client. Finally, the proxy may convert records.
248    </para>
249    <para>
250     In the current version the only supported conversion is
251     MARC21/USMARC in MARC-8 charset to MARCXML in UTF-8. Future version of
252     the proxy may do other record/charset conversions.
253    </para>
254   </section>
255   
256   <section id="other-optimizations">
257    <title>Other Optimizations</title>
258    <para>
259     We've had some plans to support global caching of result set records,
260     but this has not yet been implemented.
261    </para>
262   </section>
263
264   <section id="proxy-config-file">
265    <title>Proxy Configuration File</title>
266    <para>
267     The Proxy as an option may read a configuration file using option
268     <literal>-c</literal> followed by the filename of a config file.
269     </para>
270    <para>
271     The config file is in XML format. The YAZ proxy must be compiled
272     with <ulink url="http://www.xmlsoft.org/">libxml2</ulink> support in
273     order for the config file facility to be enabled.
274    </para>
275    <tip>
276     <para>To check for a config file to be well-formed, the yaz-proxy may
277      be invoked without specifying a listening port, i.e.
278      <screen>
279       yaz-proxy -c myconfig.xml
280      </screen>
281      If this does not produce errors, the file is well-formed.
282     </para>
283    </tip>
284    <section id="proxy-config-header">
285     <title>Proxy Configuration Header</title>
286     <para>
287      The proxy config file must have a root element called
288      <literal>proxy</literal>. All information except an optional XML
289      header must be stored within the <literal>proxy</literal> element.
290     </para>
291     <screen>
292      &lt;?xml version="1.0"?>
293      &lt;proxy>
294       &lt;!-- content here .. -->
295      &lt;/proxy>
296     </screen>
297     </section>
298    <section id="proxy-config-target">
299     <title>Configuration: target</title>
300     <para>
301      The element <literal>target</literal> which may be repeated zero
302      or more times with parent elemtn <literal>proxy</literal> contains
303      information about each backend target.
304      The <literal>target</literal> element have two attributes:
305      <literal>name</literal> which holds the logical name of the backend
306      target (required) and <literal>default</literal> (optional) which
307      (when given) specifies that the backend target is the default target -
308      equivalent to command line option <literal>-t</literal>.
309     </para>
310     <para>
311      <screen>
312      &lt;?xml version="1.0"?>
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 id="proxy-config-log">
557     <title>Configuration: log</title>
558     <para>
559      The element <literal>log</literal> is the child of element
560      <literal>proxy</literal> and specifies what to be logged by the
561      proxy.
562      </para>
563     <para>
564      Specify the log file with command-line option <literal>-l</literal>.
565     </para>
566     <para>
567      The text of the <literal>log</literal> element is a sequence of
568      options separated by white space. See the table below:
569      <table frame="top"><title>Logging options</title>
570       <tgroup cols="2">
571        <colspec colwidth="1*" colname="option"/>
572        <colspec colwidth="2*" colname="description"/>
573        <thead>
574         <row>
575          <entry>Option</entry>
576          <entry>Description</entry>
577         </row>
578        </thead>
579        <tbody>
580         <row>
581          <entry><literal>client-apdu</literal></entry>
582          <entry>
583           Log APDUs as reported by YAZ for the
584           communication between the client and the proxy
585          </entry>
586         </row>
587         <row>
588          <entry><literal>server-apdu</literal></entry>
589          <entry>
590           Log APDUs as reported by YAZ for the
591           communication between the proxy and the server (backend).
592          </entry>
593         </row>
594         <row>
595          <entry><literal>clients-requests</literal></entry>
596          <entry>
597           Log a brief description about requests transferred between
598           the client and the proxy. The name of the request and the size
599           of the APDU is logged.
600          </entry>
601         </row>
602         <row>
603          <entry><literal>server-requests</literal></entry>
604          <entry>
605           Log a brief description about requests transferred between
606           the proxy and the server (backend). The name of the request
607           and the size of the APDU is logged.
608          </entry>
609         </row>
610        </tbody>
611       </tgroup>
612      </table>
613     </para>
614     <para>
615      To log communication in details between the proxy and the backend, th
616      following configuration could be used:
617     <screen><![CDATA[
618      <target name="mytarget">
619       <log>server-apdu server-requests</log>
620      </target>
621 ]]>
622      </screen>
623     </para>
624    </section>
625
626   </section>
627   <section id="proxy-usage">
628    <title>Proxy Usage</title>
629    <para>
630    </para>
631    <refentry id="yaz-proxy">
632     &yaz-proxy-ref;
633    </refentry>
634   </section>
635   <section id="otherinfo-encoding"><title>OtherInformation Encoding</title>
636    <para>
637     The proxy uses the OtherInformation definition to carry
638     information about the target address and cookie.
639    </para>
640    <screen>
641   OtherInformation   ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
642     category           [1]   IMPLICIT InfoCategory OPTIONAL, 
643     information        CHOICE{
644       characterInfo            [2]  IMPLICIT InternationalString,
645       binaryInfo               [3]  IMPLICIT OCTET STRING,
646       externallyDefinedInfo    [4]  IMPLICIT EXTERNAL,
647       oid                      [5]  IMPLICIT OBJECT IDENTIFIER}}
648 --
649   InfoCategory ::= SEQUENCE{
650       categoryTypeId   [1]   IMPLICIT OBJECT IDENTIFIER OPTIONAL,
651       categoryValue    [2]   IMPLICIT INTEGER}
652   </screen>
653    <para>
654      The <literal>categoryTypeId</literal> is either
655      OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
656      for proxy target and proxy cookie respectively. The
657      integer element <literal>category</literal> is set to 0.
658      The value proxy and cookie is stored in element
659      <literal>characterInfo</literal> of the <literal>information</literal>
660      choice.
661     </para>
662    </section>
663  </chapter>
664  <!-- Keep this comment at the end of the file
665  Local variables:
666  mode: sgml
667  sgml-omittag:t
668  sgml-shorttag:t
669  sgml-minimize-attributes:nil
670  sgml-always-quote-attributes:t
671  sgml-indent-step:1
672  sgml-indent-data:t
673  sgml-parent-document: "yaz++.xml"
674  sgml-local-catalogs: nil
675  sgml-namecase-general:t
676  End:
677  -->
678