SERVER parameter* == SERVER=protocol[://host[:portNum]][:-:MountOptions] portNum == [+|-]number -- default: SERVER=delegate
例) 対象サーバーを限定しない Telnet-DeleGate の SERVER パラメーター
対象サーバー(host) を指定しない場合、 それは、アプリケーションレベルのプロトコルに依存した方法で、 実行時に、クライアントにより、何らかの形で与えられます。
サーバーでのプロトコルは、クライアントでのプロトコルと同様であることが、 暗黙で要求されます。 HTTP のようないくつかのプロトコルは対象サーバーとのプロトコルを指定する固有の方法を 持っています。 他の場合、例えば、MOUNT="/news/* nntp://server/*" のように、MOUNT パラメーター で明示しなければなりません。
SERVER=protocol://host:portNum は、対象サーバーの URL を指定します。
":portNum" 部分は、番号が、プロトコル標準ポート番号の場合、通常、
URL 中で省略できます。
DeleGate によって認識されるプロトコルと標準ポート番号の一覧は、
"http://delegate/-/builtin/mssgs/config.dhtml" で見られます。
Port mapping:
portNum に "-" または "+" が前置される場合、
入り口ポート番号に指定したオフセットを加えたポート番号
を割り当てます。
また、"-"(portNum なし)の場合、同じポート番号を使用します。
例) 複数ポートを単一の他のホストに転送する
特別なホスト名 "odst.-" は、入ってくるデータが
NAT で転送去れてくるときに元の対象サーバーを参照するのに使えます。
例)SOCKS プロキシー経由で、元の対象に NAT を転送する。
SERVER パラメーターが ":-:MountOptions" を伴う場合、
MountOptions に指定された条件を評価した結果が真の場合、
動的に SERVER パラメーターを選択します。
特殊な場合として、
":-:via=HostList" は、
":-:HostList" のように省略できます。
例) クライアントに適切な NNTP サーバーを選択する。
例) {NNTP,SMTP,POP}-DeleGate を単一サーバーで実行
-P21,23,25,80 SERVER=tcprelay://host:-/
ADMIN parameter == ADMIN=user@host.domain -- default: コンパイル時に指定されたもの
- | この DeleGateの 管理者名として、クライアントへの(エラー)
メッセージ中で表示する
(HTTPなど)。 |
- | クライアントに対する開始メッセージやヘルプメッセージ中で、
管理者名として表示する(FTP, NNTP, Telnet)。 |
- | 匿名アクセス FTP サーバーへ、デフォルトユーザー名として送信する
(PASS コマンドで)。 |
- | リモート SMTP サーバーへのアクセスで、
AUTH=anonftp:smtp-vrfy 認証
を行う際の送信者名として送信する (FROM コマンドで)。 |
- | 致命的なシグナルが発生したときに報告メッセージを 送信するアドレス。 |
OWNER parameter* == OWNER=user[/group][:srcHostList] -- default: OWNER="nobody/nogroup" -- 制限: ほとんどの Unix でスーパーユーザーのみ -- 制限: Windows 上でのサービスのユーザーの設定
例)クライアントのユーザー名と一致したユーザーIDで動作する
Windows で、OWNER=user を指定してサービスとして起動した時、 DeleGate サービスが作られるときのユーザーをセットします。 OWNER="" のように空のユーザーが指定された場合、ユーザー名は、 USERNAME 環境変数から取得されます。 パスワードは、PASS=pass パラメーター、環境変数で指定するか、コンソールで問い合わせられます。
CRON parameter* == CRON="crontab-spec" crontab-spec == minute hour day month dayOfWeek action -- default: none
-suspend N | -- N 秒間停止する |
-restart | -- DeleGate を再起動 |
-exit | -- DeleGate を終了 |
-expire N | -- "-atime +Nd" で、 $CACHEDIR のエクスパイアーを実行 |
-system command | -- シェルコマンドとしてコマンドを実行する |
/dir/command args | -- "-system /dir/command args" と同じ |
- args | -- "/dir/delegated args"と同じ |
-Ffunc args | -- "/dir/delegated -Ffunc args"と同じ |
例)
INETD parameter* == INETD="inetd-conf" inetd-conf == port sockType proto waitStat uid execPath argList port == [host:]portNum sockType == stream|dgram proto == tcp|udp waitStat == nowait ("wait" は、まだサポートされていません。) -- default: none
例)
INETD="8080 stream tcp nowait nobody - SERVER=http"
INETD="8080 - - - nobody - SERVER=http" (上と同じ)
INETD="8119 - - - - - SERVER=nntp://nntpserver/"
INETD="8888 - - - - /bin/date date" (以下と同じ)
INETD="8888 - - - - - SERVER=exec XCOM="/bin/date date"
INETD="8888 dgram udp - - /bin/date date"
INETD="localhost:8888 - - - - - /bin/sh sh"
INETD=+=/path/of/inetd.conf (設定をファイルから読みこむ)
HOSTLIST parameter* == HOSTLIST=listName:HostList
CLUSTER parameter* == CLUSTER=[protoList]:ServerList ServerList == [/R,]Server[,ServerList] Server == Host[..Port]
リストが "/R" で始まるとき、リスト内のサーバーはランダムな順序で試されます (最初に試されるサーバーはランダムに選択され、他のサーバーはラウンドロビンで試されます)。 これは、同等の (プロキシー) サーバー間で負荷分散するのに使えます。
このパラメーターによる再試行は、通常、サーバーの任意プロトコルでの、 サーバーへの TCP 接続を確立する段階に適用されます。 再試行には、さまざまなプロトコルの認証段階も含まれます。 HTTP 元/ゲートウェイ サーバーで、再試行はサーバーからの応答によって行われ、 例えば、応答コード 503 (Service Unavailable/サービス提供不能) と、 404 (Not Found/見つかりませんでした) が含まれます。
例)
CMAP parameter* == CMAP=resultStr:mapName:connMap connMap == ProtoList:dstHostList:srcHostList -- default: none
TLSCONF parameter* == TLSCONF=tlsConf[,tlsConf]* tlsConf == what:value -- default: TLSCONF=scache:do,xcache:do
STLS parameter* == STLS=stlsSpecs[,sslwayCom][:connMap] stlsSpecs == [-]stlsSpec[/im][/ssl][,stlsSpecs] stlsSpec == fsv | fcl | mitm | imimSec sslwayCom == {sslway [-Vrfy] [-CApath dir] ...} connMap == ProtoList:dstHostList:srcHostList -- default: none -- 制限: HTTP, FTP, SMTP, POP, IMAP, SOCKS に対して有効 -- 必須: SSLway
"fcl" を指定した場合、クライアントは STARTTLS ネゴシエーション無しで SSL を開始できます。このようなクライアントサイドからの暗黙の SSL ネゴシエーションは、 クライアント側から接続時の、SSLハンドシェイクパケットを、 セッション開始時に imimSec によって指定された、 一定時間覗くことで検出されます。デフォルト値は、"im0.25"(250m秒)です。 "-im" は、この暗黙の SSL ネゴシエーションを無効にします。 例えば、対向 (この場合サーバーとの) SSL で STARTTLS ネゴシエーションが無しに適用されるとき、 stlsSpec に、STLS="fsv/im" のように "/im" を続けます。
"mitm" を指定すると、"-fcl,-fsv" のように振る舞い、 クライアント側で SSL が有効になった後に、サーバー側の SSL が有効になります。 HTTP プロキシー DeleGate とともに使うことで、 "セキュアプロキシー(secure proxy)" または CONNECT メソッドでの双方向通信を監視する "SSL トンネル(SSL-tunnel)"、通常の HTTP と同様にフィルターとキャッシュを適用して 転送するのに使えます。 ("mitm" は、"マン・イン・ザ・ミドル(Man-In-The-Middle)" モードです。) "STLS=-mitm" オプションを設定した場合、クライアントが "https://host.domain/" に対して、 "https://-mitm.host.domain/" のように、"-mitm." を前置したサーバー名を指定したときだけ MITM モードが活性化します。
デフォルト以外の SSLway コマンドパスまたは、オプションを使う必要がある場合、 たとえば STLS="fcl,sslway -Vrfy -cert mycert.pem" のように、 stlsSpecs の後ろに SSLway コマンドを指定できます。
例)
CERTDIR parameter == CERTDIR=dir -- default: ${ETCDIR}/certs -- version: DeleGate/9.8.0 + OpenSSL0.9.8g or laters
DGCONF parameter == DGCONF=dir/file -- default: DGCONF='${EXECDIR}/${EXECNAME}.conf'
DYCONF parameter* == DYCONF=[conditions]parameters parameters == file:path | cgi:path | arg:{listOfParameters} -- default: none
読み込み条件は、新しい要求上のクライアントホスト固有の情報(アドレスまたは、名前) を基準にできます。 または、接続上のクライアントからの初期要求データの内容(サブストリングまたは、パターン) も基準にできます。 要求データは、指定した時間 (デフォルト15秒) ポーリングされ、 指定したサイズ(最大 4k バイト:デフォルト)覗き見られます。
条件:
例)
DYLIB parameter == DYLIB=libfilePattern[,libfilePattern]* -- default: DYLIB='dglib*.so,lib*.so,dglib*.dylib,lib*.dylib'
例)
LDPATH parameter == LDPATH=dirPath[;dirPath]* -- default: LDPATH='${LIBDIR};${EXECDIR};${HOME};/usr/lib;/lib'
LIBPATH parameter == LIBPATH=dirPath[:dirPath]* -- default: LIBPATH=LIBPATH='.:${STARTDIR}:${LIBDIR}:${EXECDIR}:${ETCDIR}'
DATAPATH parameter == DATAPATH=dirPath[:dirPath]* -- default: DATAPATH='.:${DGROOT}:${STARTDIR}
DGPATH parameter == DGPATH=dirPath[:dirPath]* -- default: DGPATH='+:.:${HOME}/delegate:${EXECDIR}:${ETCDIR}'
DGSIGN parameter == DGSIGN=signatureSpec -- default: DGSIGN="V.R.P/Y.M.D"
DGOPTS parameter == DGOPTS=opt[;opt]* -- default: none
SOCKOPT parameter* == SOCKOPT=[no]name[:value] -- default: reuse
PORT parameter == PORT=port[,port]* port == [host:]portNum[/udp] portNum == number[-number] -- default: none
FORWARD parameter* == FORWARD=gatewayURL[-_-connMap] gatewayURL == gwproto://gwhost[:gwport] connMap == protoList:dstHostList:srcHostList -- default: none
特別な、gwproto で、FORWARD は、 MASTER, PROXY, SOCKS、および SSLTUNNEL の一般化表記として次のように動作します。
複数の FORWARD パラメーターが指定された場合、設定された順序で試されます。 対象サーバーに対し複数のルートが利用可能な場合で、 FORWARD と、他のパラメーター(MASTER, PROXY, SOCKS, SSLTUNNEL) の混合とともに指定された場合、 FORWARD により指定されたルートは、CONNECT で、 "proxy" または、"master" により指定された優先順位で試行されます。
ROUTE parameter* == ROUTE=proto://host:port/-_-dstHostList:srcHostList -- default: none
stHostList 中のホスト指定に、"proto://" を 前置きすることで、転送するプロトコルを制限できます。 例)ROUTE="http://host:port/-_-{ftp://*}:*" は、 FTP サーバーへのアクセスだけ、"http://host:port/" の HTTP プロキシーへ 転送されることを意味します。
dstHostList 中のホスト指定は、ポート番号指定で、さらに制限できます。 例)ROUTE="http://host:port/-_-{*:21}:*" は、 ポート番号 21(FTPサービス)でだけアクセスでき、プロキシーへ転送されます。
MASTER parameter* == MASTER=host:port[/masterControl][:dstHostList] -- default: none
MASTERP parameter == MASTERP=[host:port] -- default: none
RPORT parameter == RPORT={tcp|udp}[:host] -- default: none
PROXY parameter* == PROXY=host:port[:dstHostList] -- default: none -- 制限: HTTP, FTP, Telnet に適用可能
SOCKS parameter* == SOCKS=host[:[port][/socksOpt][:dstHostList[:srcHostList]]] socksOpt == [ -4 | -r ]* -- default: none
例)
SSLTUNNEL parameter == SSLTUNNEL=host:port -- default: none
VSAP parameter == VSAP=host:port -- default: none
例)
YYMUX parameter* == YYMUX=host[:port][:connMap] connMap == ProtoList[:dstHostList[:srcHostList]] -- default: none
YYCONF parameter* == YYCONF=name[:value] -- default: none
CONNECT parameter* == CONNECT=connSeq[:connMap] connSeq == connType[,connType]* connType == cache|icp|proxy|master|https|vsap|direct|socks|udp connMap == ProtoList[:dstHostList[:srcHostList]] -- default: CONNECT="c,i,m,h,y,v,s,d:*:*:*"
connType:
cache | -- CACHE を検索 (接続しない) |
icp | -- ICP サーバーに指示された PROXY 経由 |
proxy | -- PROXY サーバー経由 |
master | -- PROXY または MASTER-DeleGate サーバー経由 |
https | -- SSLTUNNEL (HTTP 上の SSL トンネル) 経由 |
yymux | -- YYMUX サーバー経由 |
vsap | -- VSAP サーバー経由 |
direct | -- 目的サーバーへ直接接続 |
socks | -- SOCKS サーバー経由 |
udp | -- UDP による |
none | -- 接続しない |
それぞれの接続タイプは、それぞれ {c,i,m,d,v,s,u} のように、
頭文字で省略できます。
ProtoList と dstHostList が指定された場合、
リストに含まれるプロトコルとホストにのみ制御が適用されます。
例) 外部ネットワークに接続せず、ホスト上のキャッシュデータを使う場合、
CONNECT="cache:*:!./@"のように指定します。
注記) 現実装では、"cache" が connSeq に含まれる場合、 常に最初に試されます。
-Pport と CONNECT=udp の組合わせは、TCP クライアントから UDP サーバーへ中継します。 また、-Pport/udp と udp ではない CONNECT の組合わせは、 UDP クライアントから TCP サーバーへ中継します。SRCIF parameter* == SRCIF=host[:[port][:connMap]] connMap == ProtoList:dstHostList:srcHostList -- default: SRCIF="*:*:*:*:*"
このパラメーターで、それぞれのサーバーへ接続する際の ソースアドレス(ネットワークインターフェースの)を指定します。 これは、DeleGate ホストが複数のネットワークインターフェースを持つ場合に役立ちます。 それは、SOCKS-DeleDate または、FTP-DeleGate により受け付けられる クライアント接続で使用するポートの指定にも使えます。
ほとんどの場合、特殊パターン "*" を host または、port に指定した場合、 IP アドレス、またはポート番号をワイルドカード指定します。 いくつかの場合、特殊パターン "*" は、 FTP データ接続 (PORT や PASV による) 用ポート、または、 SOCKS (BIND と UDP-ASSOCIATE) 用ポートのような、 プロトコルによって指定された必要なアドレスや、ポート番号に使われます。 ワイルドカードを IP アドレスと、ポート番号で明示的に指定するには、 それぞれ、host に "0.0.0.0" を、port に "0" を指定します。
例)
要求に応じて割り当てられ、相手に通知された "ftp-data" 接続用のポート ( PORT により クライアントからサーバー、PASV によりサーバーからクライアントに向けられた) は、"ftp-data-port" または、"ftp-data-pasv" により、それぞれを個別に制御できます。 PORT のためにサーバーからクライアント、または、PASV のためのクライアントからサーバーへ 確立されるデータ接続用のソースポートは、"ftp-data-src" によって制御できます。
TUNNEL parameter == TUNNEL=tunnelType:script tunnelType == tty7 -- default: none
現状、tunnelType は、"tty7" でなければならず、それは、 DeleGate 間の伝送が 7ビットストリームで行われることを意味します。 タイプが "tty7" の場合、トンネルを確立する方法を、 指定した SHIO スクリプトファイルに書いておきます。 配布パッケージに含まれる、"src/sample.shio" を参照して下さい。 スクリプトファイル名は、絶対パスまたは、 相対パス (LIBPATH で検索できるファイル名) のどちらかで指定する必要があります。 上流のトンネル用 DeleGate は、 SERVER="tunnel1" を指定して起動しなければなりません。
例) ログインダイアログなしで、トンネルを形成する。
PERMIT parameter* == PERMIT=connMap connMap == ProtoList:dstHostList:srcHostList -- default: none
複数の PERMIT パラメーターが指定された場合、アクセスは、 少なくとも1つの PERMIT で指定された権限が許可されます。 PERMIT パラメーターがない場合、アクセス許可は、 REMITTABLE,REACHABLE,RELIABLE パラメーターによって明示されるか、 SERVER パラメーターによる暗黙の指定によって、制御されます。
例) ローカルネット上のホストには無制限に許可し、その他ホストは、http://www のみ許可します
ProtoList (dstHostList) 中の特殊パターン "*" は、 全ての許可されたプロトコル(サーバー) (REMITTABLE (REACHABLE) パラメーターによって明示することもできます) を意味します。 これらパラメーターは、可能となっている許可範囲を制限します。 プロトコル(サーバー)は、REMITTABLE (REACHABLE) パラメーターによって、 明示的または暗黙の指定で許可されていない場合、使えません。 同様に、1複数の RELIABLE パラメーターが明示的に与えられた場合、 これらは、PERMIT のsrcHostList 中にあるクライアントの許可範囲を制限します。
dstHostList で指定したホストは、"host:portNumList" のように ポート番号をつけることで、更に制限できます。 例) PERMIT="telnet:{*:23}:*" は、任意のホストに対する telnet を 標準ポート番号(23)でのみ許可することを意味します。
ProtoList 中のプロトコル名は、 "protocolName/portNumList/methodList" のようにポート番号と手段を使って変更でき、 プロトコルにおけるアクセス可能なポートと手段を制限できます。 例) 一連の PERMIT パラメーター PERMIT="ftp//readonly:Servers:Clients" PERMIT="ftp:*:*" は、 Servers に対する Client からのアップロードを禁止し、 他のサーバー・クライアントの組み合わせで、アップロードを許可することを意味します。
複数の DeleGate サーバーが、MASTER や PROXY によって連結されている場合、 元クライアントの識別情報は、 最初(連結の入り口)の DeleGate サーバーによって取得され、 上流 DeleGate サーバーへ RIDENT パラメーターを使用して転送でき、 また、PERMIT パラメーターを使って検査されます。
REJECT parameter* == REJECT=connMap connMap == ProtoList:dstHostList:srcHostList -- default: none
REMITTABLE parameter == REMITTABLE=ProtoList -- default: REMITTABLE="*" - generalist 用 -- default: REMITTABLE="." - specialist 用
プロトコル名の後ろに "/portNumList" がある場合、PortList に 指定されたポートのみが許可されます。 PortList には "/methodList" を付けることができ、 プロトコルで使える手段を制限できます。 現在、手段として、"readonly" のみが使えます。 例)REMITTABLE="ftp//readonly" は、 FTP サーバーへのアップロードを禁止する、 "読み込み専用" FTP-DeleGate を生成します。
プロトコル固有のデフォルト:
例外:
最初の指定が、"+" の場合、それはデフォルトで許可されたプロトコルのリストを意味します。
例) SERVER=http で、REMITTABLE="+,-https/80,-wais,file" の場合、
REMITTABLE="http,https/443,gopher,ftp,file" を意味します。
注記:ここでの "https" は、SSLtunnel 上の 非 https プロトコルを検出して拒否します。
SSLtunnel 上で 任意のプロトコルを中継する場合、
REMITTABLE="+,ssltunnel" のように、
"https" の代わりに "ssltunnel" を指定します。
REACHABLE parameter* == REACHABLE=dstHostList -- default: REACHABLE="*" (全てのホストに接続可能)
RELIABLE parameter* == RELIABLE=srcHostList -- default: RELIABLE=".localnet"
これは、RELIABLE=Hosts1 RELIABLE=Hosts2 のような、 複数の RELIABLE パラメーターを、 単一の RELIABLE="Hosts1,Hosts2" に、単純に結合したものと解釈しますが、 Hosts1 または、Hosts2 に、いくつかの、 否定、または、 合成演算子が含まれる場合、 "Hosts1 または Hosts2" を意味しません。 もし、この文章の意味が理解できない場合は、代わりに、 複数の PERMIT パラメーターを使用することを推奨します。
RELAY parameter* == RELAY=relayTypeList[:connMap] relayTypeList == relayType[,relayType]* relayType == proxy | delegate | vhost | no | nojava | noapplet connMap == ProtoList:dstHostList:srcHostList -- default: RELAY="delegate,nojava:*:*:.localnet" RELAY="vhost,nojava:http:{*:80}:.localnet" RELAY="proxy:*:*:*"
RELAY="no" は、中継を行わない、元 HTTP サーバーとして動作することを意味します。 (元 HTTP サーバーは、プロキシー用の書式 (要求される URL は、絶対フォーマットで、フル書式や、"/-_-" 書式ではありません) ではない通常の書式での要求を受け付ける、通常のサーバーです。)
"transparent-proxy (透過プロキシー)" と呼ばれる機能は、"RELAY=vhost" で有効にできます。 RELAY="vhost" は、任意の仮想ホストにも中継する、元 HTTP サーバーに使用できます。 このオプションは、明示された MOUNT を指定せずに、 要求ヘッダー中の "Host:" フィールドで指し示された 任意の対象サーバーに、 HTTP 要求を転送可能にします。 この自動転送は、要求された URL が MOUNT されていない場合のみ実行されますが、 ほとんどの DeleGate は ルート URL ("/*") 用の MOUNT パラメーターが指定された 元サーバーとして動作しているため、それほど使われそうにありません。
他の relayType と連結した "nojava" は、<APPLET>,
<EMBED> および、<OBJECT> タグ を、relayType によって、
使用不能にします(<killed-TagName> に置き換えられます)。
"noapplet" をともなう場合、<APPLET> タグのみが使用不能になります。
RERAY パラメーターにより、relayType "delegate" を使用可能にした場合、
上記、デフォルトである "nojava" の使用を強く推奨します。
例)
デフォルト:
SCREEN parameter == SCREEN={reject|accept} -- default: none
AUTH parameter* == AUTH=what:authProto:who -- default: none
HTTP-DeleGate の場合、(要求メッセージ中の) Authorization ヘッダー
にある Username:Password で、
"私は誰”かを宣言します。ここでの Username は、
User@Host にもできます。
User, Host, Password のセットを得た後、
DeleGate は、
Host の(FTP)サーバーに、
User と Password でログインを試みます。
成功した場合、
クライアントは User@Host で
認証されます。
現在、以下のカテゴリでの、 認証/権限付与がサポートされます。
-- 任意プロトコルの DeleGate の場合 --
さまざまなプロトコルの DeleGate (SERVER=protocol にかかわらず) は、
"-PuserPort,adminPort/admin" のように、 "/admin" 修飾子をもつ管理専用ポートを指定することで、
リモート管理用ポートを持つことができます。
例)
-- FTP サーバー と FTP/HTTP ゲートウェイの場合 --
3番目のフィールドが "-" である場合(すなわち、AUTH="anonftp:smtp-vrfy:-@*")
"host.domain" 上のメールサーバーに対する接続のみがチェックされます。
-- プロキシーと 元 HTTP サーバーの場合 --
ident | -- 識別プロトコル [default] |
pauth | -- Proxy-Authorization フィールド "user@host:password" を使用 |
auth | -- Authorization フィールド "user@host:password" を使用 |
FTP サーバーベースの認証を使用する場合、 要求される認証情報としてのユーザー名は、 "user@host.domain" のような、E-mail アドレスです。 なお、これは通常、AUTH="anonftp" と AUTH="proxy" 両方で使えます。
AUTHORIZER parameter* == AUTHORIZER=authServList[@realmValue][:connMap] authServList == [authForw,]authServ[,authServ]* | & | * authForw == -map{inPat}{localPat}{fwdPat} | -strip | -fwd authServ == authHost[/portNum][(reprUser)] authHost == hostName | hostAddr realmValue == word | {words separated with space} connMap == ProtoList:dstHostList:srcHostList -- default: none -- 制限: Telnet, FTP, NNTP, SMTP, IMAP, Socks, SockMux および、HTTP に、適用可能
注記: auth-server により認証されたクライアントは、そのクライアントホストが、 他のアクセス制御 (RELIABLE と PERMIT) を通過しない場合、許可されません。 認証された全クライアントを、そのホストを無視して許可したい場合、 RELIABLE="-a/*" のように指定します。 この用途で、RELIABLE="*" も動作しますが、DeleGate と設定変更で使うのは危険です。
connMap に追加するとき、認証サーバーは、 対象プロトコル、サーバーホスト、クライアントホストの組合わせで、条件付で選択できます。 authServList は、認証サーバー名、または、認証サーバーのホスト名リストです。 authServList の後ろに、"@realmValue" が付く場合、 その値は、HTTP-DeleGate における、保護空間の領域指定に使えます。 それは、それぞれの MOUNT ポイントに対して、マウントオプション "realm=realmValue" で上書き可能です。
現在、リモート認証/権限付与サーバーのプロトコルは、 FTP プロトコルの USER/PASS コマンドです。 このように、DeleGate の認証/権限付与サーバーには、 任意の実在の FTP サーバーを使用できます。 他の方法として、DeleGate 自らが持つ 認証/権限付与のためのリストは、 -Fauth 機能により管理できます。
次のように、組み込み auth-server を authServ として使用します:
例)
例)
コマンドによる認証の結果は、その出力文字列か、終了コードで表されます。
コマンドはその標準出力に結果を FTP プロトコルでのステータス応答形式で表し、
成功時 "230"、失敗時 "530" です。
他の場合、プロセスの終了コードが使われ、0 が成功、0 以外が失敗です。
例) ユーザー名を引数で渡し、パスワードを環境変数で渡す。
[myauth コマンドの内容]
//ダイジェスト認証をクライアントと行う HTTP プロキシー、または、サーバー
SERVER=http AUTHORIZER=-dgauth
// クライアントと、APOP 認証を行う、POP プロキシー
SERVER=pop MOUNT="* pop://server/*" AUTHORIZER=-dgauth
注記: ほとんどの PAM 認証の実行には、Unix 上のスーパーユーザー特権
(OWNER="root" オプション付加) が必要です。
しかし、DGROOT/subin/ に
外部プログラム "dgpam" をインストールすることで、
スーパーユーザー特権をともなう DeleGate を実行することを避けられます。
PAM 認証は、リモート PAM サーバーに委任することもできます。
AUTHORIZER="-list{u1:p1,u2:p2}(local),-pam,-none(anonymous)"
// ユーザーは、"local" または PAM でのユーザー、またはその他の "anonymous"
// として認証されます。
AUTHORIZER="-cmd{myauth %U}{MYPASS=%P}"
#!/bin/sh
if [ "$1" = "user1" -a "$MYPASS" = "pass1" ]; then
echo "230 SUCCESS"
else
echo "530 FAILURE"
fi
"-map" プリフィックスは、入ってくる USER と PASS の認証情報 (inPat パターンで)
を分離し、一対の認証(1つは authServList (localPat 内の) によりローカルで使われ、
他は (fwdPat 内の) サーバーに転送されます) にします。
一致または生成される各認証情報は、"username:password" として一対の
ユーザー名とパスワード文字列であらわされます。
fwdPat により生成されるユーザー名文字列が "@Host" で終わる場合、
それは取り除かれ、Host は対象サーバーとして使われます。
文字列は共通仕様フォーマットパターン (MOUNT でのマッチングパターンで使われる) に一致した形式で生成されます。
(例) -strip
(例) -fwd
u1 または PAM によるローカル認証 <-- USER user1 + PASS pass1
サーバー h2 に送られる <-- USER user2 + PASS pass2
(例)
上記例1で見せたのは、"-strip" が、USER "u1@u2@u3@h3@h2@h1" と PASS "p1@p2@p3"
として、ユーザー名とパスワードの多重化に使うということ。
USER と PASS の '@' より前の最初の部分を取り除きローカル認証に使い、
USER 内の '@' 以降の最後の部分は対象サーバーとして、残りの文字列は対象サーバーに転送されます。
"-fwd" 指定は、同じ USER と PASS をローカル認証と、サーバーとの認証の両方に使います。
認証されたユーザーに権限を与えない必要があるときのみ、 authServList として、以下の特別な名前が便利でしょう。
例)
MYAUTH parameter* == MYAUTH=username:password[:connMap] -- default: none -- 制限: Socks, VSAP, SMTP, および HTTP のみに適用可能
クライアントから送られた、ユーザー名+パスワードの組は、 MYAUTH="%U:%P" でサーバーに転送できます。 (HTTP および、FTP でのみ使えます)
注記: プロキシーとの認証では、MYAUTH の代わりに認証情報を含むゲートウェイ URL を FORWARD とともに使用することが強く推奨されます。 例) SOCKS=host:port と MYAUTH=user:pass は、 FORWARD=socks://user:pass@host:port と、表現できます。
例)
RIDENT parameter == RIDENT=ridentType[,ridentType]* ridentType == client|server -- default: none
例)
MAXIMA parameter* == MAXIMA=what:number,... -- default: MAXIMA=listen:20,ftpcc:2,...
randstack | -- | セキュリティ用スタックベースのランダマイズレンジ [32] |
randenv | -- | 環境変数ベースのランダマイズレンジ [1024] |
randfd | -- | クライアントソケットファイルディスクリプターのランダマイズレンジ [32] |
listen | -- | 入り口ポートキューの最大サイズ [20] |
delegated | -- | 一度に実行できる DeleGate プロセス数の最大値 [64] |
service | -- | delegated プロセス単位の最大サービス数 [無制限] |
standby | -- | スタンバイプロセスの最大数 [32] |
conpch | -- | クライアントホスト単位の最大同時接続数 [無制限] |
ftpcc | -- | サーバーからホストに対する FTP 接続キャッシュの最大数 [16] |
nntpcc | -- | サーバーからホストに対する NNTP 接続キャッシュの最大数[16] |
http-cka | -- | (HTTPCONF=max-cka で置き換えられました) |
http-ckapch | -- | (HTTPCONF=max-ckapch で置き換えられました) |
udprelay | -- | 並列 UDPrelay クライアントの最大数[32] |
winmtu | -- | Win32 における send() 単位の最大値[1024] |
TIMEOUT parameter* == TIMEOUT=what:seconds,... -- default: TIMEOUT=dns:10,acc:10,con:10,lin:30,...
shutout | -- | 致命的エラーでセットされた、シャットアウトを解除する [1800] |
dns | -- | DNS 参照 [10] |
dnsinv | -- | DNS 逆引き参照 [6] |
nis | -- | NIS 参照 [3] |
acc | -- | クライアントの受入れ (FTP データ接続含む) [10] |
con | -- | サーバーへの接続 [10] |
lin | -- | 出力のための LINGER [30] |
authorizer | -- | AUTHORIZER による権限の有効期限 [unlimited] |
dgnonce | -- | AUTHORIZER=-dgauth 用 ("nonce" の寿命) [60] |
ident | -- | Ident サーバーへの接続 [1] |
rident | -- | RIDENT=client 情報の受取り [1.0] |
io | -- | 一般入出力 (データ転送ではない) [600] |
silence | -- | クライアント・サーバーどちらからもデータ送信無し [0] (tcprelay のみに適用) |
hello | -- | MASTER との HELLO ネゴシエーション [30] |
login | -- | プロキシーへのログイン (Telnet, FTP, SOCKS) [60] |
daemon | -- | delegated [無制限] |
restart | -- | 指定した期間毎に再起動 [無制限] |
standby | -- | 次のクライアントのため delegated が待機する時間 [30] |
takeover | -- | クライアント切断後ダウンロード内容をキャッシュに書込むまで [5]
(ダウンロードを開始した、クライアントの切断後) |
ftpcc | -- | FTP 接続キャッシュのキープアライブ [120] |
nntpcc | -- | NNTP 接続キャッシュのキープアライブ [300] |
http-cka | -- | (HTTPCONF=tout-cka に置き換えられました) |
cfistat | -- | -s,filter からの 状態情報用 [1.0] |
DELAY parameter* == DELAY=what:seconds -- default: DELAY=reject:60,unknown:60,...
reject | -- | 自分もしくは、マウントしたサーバーからの連続的拒否(Reject)応答 [60] |
unknown | -- | 自分もしくは、マウントしたサーバーからの連続的不明(Unknown)応答 [60] |
reject_p | -- | 元サーバーからの、連続的拒否(Reject)応答 [0] |
unknown_p | -- | 元サーバーからの、連続的不明(Unknown)応答[0] |
CHOKE parameter* == CHOKE=Choking:Client:Ua:Referer:Url:Server:Protocol -- default: none
MOUNT parameter* == MOUNT="vURL rURL [MountOptions]" -- default: MOUNT="/* SERVER_URL*"
vURL が "*" で終わる場合、 部分的に一致したパスも書換えられます。 rURL が "*" で終わる場合、 部分的に一致したパスの残り部分は、そのまま rURL の後にコピーされます。
例) HTTP-DeleGate での MOUNT
vURL か rURL に "=" を指定した場合、 マウントは、リクエスト中の vURL を書換えない、 または、 応答中の rURL を書換えるのと同じです。
対象サーバーのポート番号 (rURL において) には、
"-" か "+" が前置きでき、
これは、SERVER
パラメーターに設定した入り口ポート番号に対して、
動的に決定したオフセットを与えます。
rURL (または SERVER パラメーター) 内の特別なホスト名 "odst.-" は、
NAT (Linux 上の iptables で提供される) 経由のクライアントからの TCP 接続の
元の対象ホストを表します。
これは、任意プロトコルの透過プロキシー(または ゲートウェイ) を構成するのに使えます。
元の対象ポート番号は、"odst.-:-" のように、"-" で参照できます。
番号は、例えば、"-8000" や "+8000" のようにオフセットを付けて割り当てられます。
"odst.-" 名は、"rserv" マウントオプションでも使えます。
rURL が "file:path" で path が相対の場合、 データファイルは、DGROOT ディレクトリー、 または DATAPATH に設定された ディレクトリー内で検索されます。 rURL が "vurl:rURL" のように前置きされるなら、 vURL から rURL への書き換えられた URL(要求メッセージ中の) は、他の MOUNT で再度書き換えられます。 この再帰的な MOUNT は、rURL to vURL への応答データ内の URL には、 適用されないので、応答中の URL が逆書き換えされることが、さらに期待されるような、 HTTP では期待の動作はしません。
例) 再帰的な MOUNT
省略形
設定を簡単で再利用可能にするために、 URL の特別な省略形を MOUNT パラメーターで使用できます。 protocol-name://host-name:port-number/url-path からなる rURL 中の protocol-name, host-name, port-number に "=" を指定した場合、 それは、DeleGate 自身をあらわします (すなわち vURL 中のそれ)。 URL が "//" で始まる場合、更なる省略形で、 "///path" は "=://=:=/path" を意味し (プロトコル,ホスト,ポートが同じ)、 また、 "//serv..." は "=://serv..." を意味します (同じプロトコル)。
省略された host-name と、port-number は、 存在する場合、仮想ホスト(HTTP の Host: フィールドで与えられた)の、 または、クライアントとの実インターフェースのそれに置き換えられます。 実インターフェースを明示的に指定する場合、"-P" を "http://-P/path" のように、"host-name:port-number" 部分に使用します。
例) MOUNT パラメーター中の rURL の省略形
マッチングと書換えの複合
vURL と、rURL のパターンの後に "*%" がつく場合、 scanf(3) と似た書式で指定した複合マッチングのためのパターンを表します。 それぞれの書式指定は、"%" に続く指定("%c", "%[a-z]" など)からなります。 拡張書式 "%S" は、隣接したキャラクターにより決定される変数を意味します。 すなわち "%Sx" は "%[^x]x" を意味します: 例) "%S." は "%[^.]." および "%S/" は "%[^/]/" rURL 中の "%(N)" は、 vURL 中の N 番目の 要素の複製を意味します。 vURL パターンが "$" キャラクターで終わる場合、 URL 文字列末端と完全に一致する必要があります。
例) 複合マッチングと書き換え
MountOptions == option[,option]*
条件:
最初のオプショングループは、MOUNT をソースと対象 (クライアントとサーバー)
により条件的に行います。
MOUNT パラメーターに、
1つ以上の条件を含む MountOption を指定した場合、
全ての条件が真にならない限り、MOUNT は無視されます。
これら HostList は、host:port のリストでなければならず、 ここでの :port 部分は、特に気にしない場合省略できます。 host 部は、"*" で置換えでき、 その場合ネットワークインターフェースの違いを気にしません。
例)
制御系:
オプションの2番目のグループは、局所的な MOUNT ポイントに
対する DeleGate の動作を制御します。
URICONV parameter* == URICONV={convSpec|defElem|defAttr} convSpec == convList:attrList defElem == defelem:+,elemnameList defAttr == defattr:+,attrnameList -- default: URICONV=dump で見られます。
mount | -- | MOUNTにより書換え |
normal | -- | URL パス中に"../"を含む MOUNT された URL を正常化する |
partial | -- | 可能なら、(MOUNT された) URL を部分的 URL で表現する。 |
full | -- | 全ての URL をフル URL に変換 |
特別な convList URICONV="+" は、デフォルトの URICONV の設定 (この場合、現実装では attrList はありません) を読みこむことを意味します。 attrList は、属性名リストで、それぞれは、1つの要素名を前置きできます。 特別な属性名 "+" は、属性のデフォルトセットを意味します。 "-" が前置きされた属性は、指定済みの属性セットから除かれます。
他の特別な convList URICONV="where:any" は、 書換える URL の検索対象を HTML タグだけではなく、 XML, JavaScript,CSS (Cascading Style Sheets) および、 SWF (Shockwave Flush) にも行いますします。
例)
BASEURL parameter == BASEURL=URL -- default: none
元/ゲートウェイ HTTP-DeleGate が要求ヘッダー内の "Host:vhost1" を受け取った場合、 "vhost1" を DeleGate のベース URL とするため、 BASEURL="http://vhost0" パラメーターは無視されます。 BASEURL によって、"Host:" ヘッダーを上書きしたい場合、 BASEURL="http://-vhost0" の様に "-" をホスト名の前につけます。
例)
DELEGATE parameter == DELEGATE=gwHost:Port[:ProtoList] -- default: DELEGATE=currentHost:currentPort
元々、このパラメーターは、
gateway-_-URL をともなう
URL (または、ポインタ) や、proto://gwHost:Port/-_-URL
(この gwHost:Port部は、DeleGateによって生成され、埋め込まれたものです)
表記によって書換えられた、CERN HTTP タイプではないプロキシー (gopher プロキシー含む)
のためのプロキシーモードを制御するために取り入れられました。
このパラメーターは、gwHost:Port 部の表現をカスタマイズするために
取り入れられました。
これは、この DeleGate の入り口ポートを表し、
クライアントから解決可能で到達可能でなければなりません。
もっとも一般的な指定は、gwHost のデフォルト値は、
この DeleGate ホストの現ネットワークインターフェースで、
現クライアントはこれを経由し、この DeleGate に到達させ、
また、生の IP アドレスで、表現します。
これにより、クライアントが DeleGate のホスト名解決法を知らなくても、
DeleGate に到達可能になります。
例外的に、入り口ポートが、"-Phost:port”のように
ネットワークインターフェースを明示して指定された場合、
DELEGATE のデフォルト値は、host:port になります。
オプションの ProtoList を指定することで、
このプロキシーでのプロトコルに制限をかけることができます。
応答メッセージ中の URL (ポインタ) は、
"proto://gwHost:Port/-_-" を前置きして、書換えられます。
そのため、ProtoList にプロトコルが含まれる場合、要求は再びこの
DeleGate (gwHost:Portの) に向けられます。
DELEGATE="-:0:-all" のように、存在しない入り口ポートと、 空の ProtoList を指定することで、プロキシーモードを使用不能にできます。 RELAY パラメーターを使用することで、もっと、簡単に実現できますが、 最近のバージョンでは、デフォルトで、無効になっています。
COUNTER parameter == COUNTER=listOfCounterControl counterControl == do | total | acc | ssi | ref | err | ro | no | mntpV -- default: COUNTER=no -- 制限: HTTP, SMTP, FTP, DNS に適用可能
それぞれのアクセスカウンターは、"ADMDIR/counts/access/URL#count" にあるファイルに保存されます。それぞれのカウンターファイルは、 ASCII 10進数形式でのアクセス数で構成された行で始まり、 手動で、初期化/編集できます。 行には、3つの数を含めることができ、1つ目はアクセス数の総合計で、 2つ目は、同一クライアントからの複数回アクセスを除くアクセス数で、 3つ目は、最後の10クライアントからの複数回アクセスを除いたアクセス数です。 それぞれのカウントは、%T, %U, %V それぞれ、後述の書式文字列に置き換えられます。
カウンターは、PAGE_COUNT または、COUNTER 値として、 SSI を使うことで指定した書式で表示できます。 タグ内に "url" を指定しない場合、タグを含む SHTML ファイルの URL を意味します。 カウンター値は、下記の "fmt=..." 属性であたえられた書式文字列で 印刷可能キャラクター文字列に変換にします。 書式の初期値は、"%T" です。
書式指定子:
例)
総合計は、TOTAL_HITS タグまたは "sel=total" を伴う COUNTER タグで表示されます。 URL のリファラカウンターは、HTTP 要求の "Referer:" ヘッダーに URL がある場合加算されます。 それぞれのリファラカウンターは、 "ADMDIR/counts/referer/URL#count-ref" に保存されます。 リファラカウンターは、PAGE_COUNT タグ内の "sel=ref" 属性 で表示できます。
例)
各 URL に対するカウンターを全て有効にするのは、不経済で/か不要かもしれません。 代表として MOUNT ポイントのカウンターを使用するか、 サーバーーの総合計アクセスカウンターだけを使用うことで、 カウンターを削減できます。 以下の例では、全ての URL のカウンターがデフォルトで (COUNTER=do で) 有効です。 /srv1/ 以下の URL のカウンターは、/srv1/ のカウンターで表され、 さらに、サーバーの 総合計と、SSI カウンターは、/mine/ 以下の URL でだけ有効になります。 例で示されるように、COUNTER は、 デフォルト値を COUNTER パラメーターから引き継ぐように、 MountOptionとして指定することができます。
例) COUNTER=do MOUNT="/srv1/* http://srv1/* COUNTER=mntpV" MOUNT="/mine/* file:dirpath/* COUNTER=no,total,ssi"
COUNTERDIR parameter == COUNTERDIR=dirPath -- default: COUNTERDIR='${ADMDIR}/counts[date+/year%y/week%W]'
CACHE parameter* == CACHE=cacheControl[,cacheControl]*[:connMap] cacheControl == do | no | ro connMap == ProtoList[:[dstHostList][:srcHostList]] -- default: none -- 制限: HTTP, FTP, NNTP, Gopher に適用されます。
EXPIRE parameter* == EXPIRE=validity[/custody][:connMap] connMap == ProtoList:dstHostList:srcHostList validity == period custody == period period == Num[d|h|m|s] -- default: EXPIRE=1h
CACHEFILE parameter == CACHEFILE=fileNameSpec -- default: CACHEFILE='$[server:%P/%L/%p]'
%P | -- | scheme | プロトコル名部分 |
%L | -- | host.d2.d1:port | ログイン (またはサイト) 部分 |
%H | -- | host.d2.d1 | ホスト名 |
%T | -- | port | ポート番号 |
%h | -- | d1/d2/host | 階層化ホスト名ディレクトリー |
%d | -- | d1/d2 | 階層化ドメイン名ディレクトリー |
%1 | -- | d1 | 最上位ドメイン |
%2 | -- | d2 | 第2ドメイン |
%p | -- | path | URL-パス部分 |
%Q | -- | host.d2.d1.d0 | FQDN なホスト名を使用 (%Q%L または %Q%H 同様) |
他の書式パターンは、"$[hash:format]" で、format
により生成された文字列を、
"00" から "1f" の範囲の 16進の値にハッシュします。
これは、全てのサーバーを含む、
1つの巨大なディレクトリーを 32 の小さなディレクトリー に分割します。
また、物理的に異なるディスクに分散して保存することもできます。
例)
ICP parameter* == ICP=icpServerList[:icpServerSpec[:connMap]] icpServerList == icpServer[,icpServer]* icpServer == icpHost[/icpType/proxyPort/icpPort] icpServerSpec == icpOptions:proxyPort:icpPort connMap == ProtoList:dstHostList:srcHostList -- default: none -- 制限: {HTTP,FTP}-DeleGate に対し適用
s | -- ICP サーバーは、"sibling"(兄弟) [default] |
p | -- ICP サーバーは、"parent"(親) |
l | -- ICP サーバーは、応答しない "listener" (リスナ) |
n | -- ICP サーバーは、ナビゲーションプロキシー |
o | -- HIT_OBJ 応答が必要 |
H | -- 対象サーバーは、HTTP プロキシー [default] |
D | -- 対象サーバーは、MASTER-DeleGate. |
O | -- 対象サーバーは、元サーバー |
timeout/N | -- ICP クライアントとしての応答待ち時間(秒) [2.0] |
parent | -- icpServers のデフォルトタイプを "parent" にする |
listener | -- icpServers のデフォルトタイプを "listener" にする |
hitobj | -- デフォルトで 全 icpServers に HIT_OBJ を許可 |
Origin | -- 対象サーバーは、元サーバー |
DeleGate | -- 対象サーバーは、DeleGate |
例)
CHARCODE parameter* == CHARCODE=[inputCode/]outputCode[:[tosv][:connMap]] outputCode == charCode charCode == iso-2022-jp | euc-jp | shift_jis | utf-8 | us-ascii | JIS | EUC | SJIS | UTF8 | ASCII | guess connMap == [ProtoList][:[dstHostList][:[srcHostList]]] -- 制限: HTTP, FTP, SMTP, POP, NNTP, Telnet, Tcprelay に適用 -- default: none
疑似コード名 "guess" は変換は行わないということですが、 メッセージ中の "Content-Type" ヘッダーに追加される "charset" 属性が 欠けている場合には、メッセージボディからそれを推測します。 これは、EUC-JP のような非アスキーコードが、ビューアによりヨーロピアンとして 推測されてしまうような、メッセージが日本語にローカライズされていない ビューアプログラム(例えば、ウェブブラウザー)のときに便利です。
"tosv" が指定されているなら、変換は要求メッセージ(または、サーバーへ向けたメッセージ) に適用されます。 変換は、その要求 URL 内に "%XX" でエンコードされたHTTP要求メッセージや、 POST メッセージ (Content-Type: application/x-www-form-urlencoded でエンコードされているとき) 内の日本語テキストの断片にも適用されます。 変換が適用される Content-Type の値一式は HTTPCONF=post-ccx-type で指定できます。
変換対象のアプリケーション(プロトコル)は、connMapで指定した、 指定のプロトコル一式、サーバー/クライアントだけに制限できます。 connMap 内での ProtoList, dstHostList, srcHostList の初期値は "*" で、全てのプロトコルやホストと一致します。
例) クライアントへ応答を UTF8 で送り、HTTP サーバーへの要求を Shift_JIS で送る
FTP プロトコルでの変換は、デフォルトでデータ接続上を ASCII 形式で転送されるデータのみに適用されます。 これは、FTPCONF="ccx:any" を伴うことで、バイナリデータやコントロール接続上のデータにも適用されます。
このパラメーターをインターネットメール/ニュースプロトコル (SMTP, POP, NNTP) で 有効にする場合、 キャラクター変換を有効 (デフォルトで有効) にするために MIMECONV パラメーターも指定する必要があります。
HTTP クライアントは、要求メッセージ中の "Accept-Language" フィールドで選択して (各クライアント(WWWブラウザー)で指定できるかもしれません)送信することで、 この指定を無視できます。 例) クライアントの要求で "Accept-Language: (charcode=EUC)" が送られた場合、 応答テキストは、DeleGate の CHARCODE 指定を無視して、 EUC に変換されます。 "Accept-Language: (charcode=THRU)" が指定された場合、 管理者がこの DeleGate に指定した全ての変換は 無効になります。
CHARMAP parameter* == CHARMAP=mapType:charMap[,charMap]*[:tosv] mapType == ascii | ucs | jis | ucsjis | jisucs charMap == inCharCode1[-inCharCode2]/outCharCode2[-[outCharCode2]] charCode == hexa-decimal code | single ASCII character -- default: none
割り当てられる文字は、16進表現の値 (2桁以上で表される) または、
1桁の文字そのものです。
さまざまなエンコード方法 (ISO-2022-JP, EUC-JP, Shift_JIS) によりエンコードされた
JIS X 0208 文字セット内の文字は、"2121" のような、
最上位ビット(8080)がない JIS コードで表現されます。
JIS X 0212 文字セット内の文字は、"1222F" のような "1" を前置きした
その JIS コード値で表現されます。
inCharCode2 と outCharCode2 を指定した場合、
範囲内のそれぞれの文字に一致する文字に割り当てられます。
-outCharCode2 が与えられない場合、範囲内の全ての入力文字は、
outCharCode1 に割り当てられます。
mapType は、以下のいずれかです:
例) 小文字と大文字を逆転
例) "rot13" 符号化
例) JIS X 0208 内の全ての日本語文字を "下駄マーク" に置き換える
例) JIS X 0212 内の全ての日本語文字を "下駄マーク" に置き換える
例) 知らない文字を "下駄マーク" の代わりに "白い四角" で表現する。
HTMLCONV parameter == HTMLCONV=convList convList == conv[,conv]* conv == deent|enent|fullurl -- default: HTMLCONV=deent
deent | -- | decode entity symbol |
enent | -- | encode entity symbol |
fullurl | -- | convert all of URLs to full URLs (equals to URICONV="full:+,-HREF/BASE") |
"deent" と "enent"は、HTML とプレーンテキスト間での特別なキャラクター
(例:"<" から/へ "<" などが、マルチバイトキャラクターセット(ISO-2022-JP など)のテキスト中に現れた場合)
のエンコード・デコードを制御します。
"deent" が指定された場合、
エンコードされた実シンボルがマルチバイトテキスト中
に現れた場合デコードします。
これは、マルチバイトキャラクターを気にしないエンコーダで
無差別にエンコードされたキャラクターが含まれるテキストを
修復するときに便利です。
"enent" が指定された場合、実シンボルがマルチバイトキャラクターセット以外の
テキスト中に現れた場合、エンコードします。
これは、WWW クライアントによってアクセス
される NNTP-DeleGate の場合便利です。
空リストが指定された場合、全ての変換を停止します。
MIMECONV parameter == MIMECONV=mimeConv[,mimeConv] mimeConv == thru | charcode | nospenc | textonly | alt:first | alt:plain -- default: none -- CHARCODE パラメーターが与えられた場合 MIMECONV=""
部品リストを選択または展開する事で、"multipart/*" メッセージ をフィルタして平文メッセージに変換するオプションを以下に示します。
FCL parameter == FCL=filterCommand FTOCL parameter == FTOCL=filterCommand FFROMCL parameter == FFROMCL=filterCommand FSV parameter == FSV=filterCommand FTOSV parameter == FTOSV=filterCommand FFROMSV parameter == FFROMSV=filterCommand FMD parameter == FMD=filterCommand FTOMD parameter == FTOMD=filterCommand FFROMMD parameter == FFROMMD=filterCommand filterCommand == [-s,][-p,][-w,]command -- default: none
フィルターは、サーキットレベル情報では、 CMAP で、 アプリケーションレベル情報では、 CFI script を使うことで、 条件付で利かせることができます。
組み込みフィルター: filterCommand に "-" が前置きされる場合、
それは DeleGate の組み込みフィルターです。
例)
-n -- 出力ライン数
-t -- 出力ラインに対するタイムスタンプ
-v -- 不可視キャラクターを表示
-l -- (-tee を伴う) 出力を stderrに代わり、LOGFILE に出力 (デフォルト)
-e -- (-tee を伴う) stderr に出力
XCOM parameter == XCOM=filterCommand XFIL parameter == XFIL=filterCommand -- default: none
WindowsNT と OS/2 では、 XCOM で実行されたコマンドには、 クライアントに接続したソケットを受継ぐハンドル値を持つ、 環境変数 "SOCKHANDLE_CLIENT" が提供されます。
CHROOT parameter == CHROOT=dirPath -- default: none -- 制限: ほとんどの Unix で super-user のみ
DGROOT parameter == DGROOT=dirPath -- default: ${STARTDIR}/DGROOT がある時はそれを使い、 Unix では、'/' CHROOT が設定されるか '${HOME}/delegate', '/var/spool/delegate-${OWNER}', '/tmp/delegate-${OWNER}' の場合 Windows: '/Program Files/DeleGate'
SHARE parameter == SHARE=dirPatternList -- default: empty
例)
UMASK parameter == UMASK=mask -- default: umask(2) の値
VARDIR parameter == VARDIR=dirPath -- default: VARDIR='${DGROOT?&:/var/spool/delegate}'
CACHEDIR parameter == CACHEDIR=dirPath -- default: CACHEDIR='${VARDIR}/cache'
ETCDIR parameter == ETCDIR=dirPath -- default: ETCDIR='${VARDIR}/etc'
ADMDIR parameter == ADMDIR=dirPath -- default: ADMDIR='${VARDIR}/adm'
LOGDIR parameter == LOGDIR=dirPath -- default: LOGDIR='${VARDIR}/log' -- v10-default: LOGDIR='log[date+/y%y/m%m/%d]'
LOGFILE parameter == LOGFILE=[LogFilename] PROTOLOG parameter == PROTOLOG=[LogFilename][:logFormat] ERRORLOG parameter == ERRORLOG=LogFilename TRACELOG parameter == TRACELOG=LogFilename -- default: LOGFILE='${LOGDIR}/${PORT}' -- default: PROTOLOG='${LOGDIR}/${PORT}.${PROTO}' -- default: ERRORLOG='${LOGDIR}/errors.log' -- default: TRACELOG='${LOGDIR}/ptrace.log'
パターン ${PROTO} と ${PORT} は、それぞれ、 この DeleGate のプロトコル名と、ポート番号に置換えられます。 これらファイルとディレクトリーは、 可能な場合、DeleGate により自動生成されます。 LOGFILE="" や PROTOLOG="" のように空ファイル名を指定することでログを停止できます。
HTTP 用の PROTOLOG 書式は、 共通ログファイル書式と互換で、 また、カスタマイズ可能です。FTP 用の PROTOLOG 書式は、 xferlog 互換です。
SYSLOG parameter* == SYSLOG=[syslogOpts,][syslogServ] syslogOpts == syslogOpt[,syslogOpts] syslogOpt == -vt | -vs | -vS | -vH | -fname -- default: none
複数の SYSLOG パラメーターで、syslogServ で指定した それぞれの複数の異なる対象にログデータを送信する設定ができます。 syslogServ は、syslog サーバーか、ローカルファイルの URL です。 syslogServ のデフォルトは、ローカルのロガー (ログは、標準 "syslog()" 関数経由で送られます) です。 それぞれの対象に対し、ログ書式と詳細さは、以下の syslogOpt を前置して指定できます:
-vt | -- LOGFILE を簡素化 |
-vs | -- LOGFILE 無し |
-vS | -- PROTOLOG 無し |
-vH | -- syslog ヘッダーを省略 |
-fname | -- ファシリティ名 "daemon" の代わりに name を使う |
例)
SYSLOG= | -- ローカルの syslog へ |
SYSLOG=syslog://host | -- 遠隔の syslog サーバーへ |
SYSLOG=syslog://host:port | -- 非標準ポート |
SYSLOG=/dev/tty | -- コンソールへ |
SYSLOG=file:path | -- ローカルファイルへ |
SYSLOG=-vH,file:path | -- syslog ヘッダーを省略 |
SYSLOG=-fdaemon | -- "daemon" ファシリティとして (デフォルト) |
SYSLOG=-flocal1 | -- "local1" ファシリティとして |
遠隔 syslog サーバーへの syslog UDP パケットの送信元ポート (とアドレス) は、例えば、
SRCIF=":8514:syslog"
(または SRCIF="xx.xx.xx.xx:8514:syslog"
のように指定できます。
各アプリケーションプロトコルのサーバーとクライアントを基準とした syslog サーバーの
切替えは、(まだ) サポートされていません。
エージングのための LogFilename と dirPath の置換え
例) 1ヶ月で循環する毎日のログ
例) 日付による階層ディレクトリーを持つログ
最新のログファイルは、 LOGFILE 指定の "[date+format]" 部を省略した名前で作成された、 違うファイル名 (ハードリンクされた) を指しています。 例)上記例の LOGFILE 指定で、 ログファイルは "log/aged/00/12/31/80.http" のようになり、 最新のログは、他の名前 "log/80.http" となります。
他のエージングパターン "[start+format]" は、 同様に評価され、"date+" を除いた、 DeleGate が開始した時間 (SIGHUP または、TIMEOUT=restart による再起動) に置換えられます。
EXPIRELOG parameter == EXPIRELOG=LogFilename -- default: EXPIRELOG='${LOGDIR}/expire.log'
WORKDIR parameter == WORKDIR=dirPath -- default: WORKDIR='${VARDIR}/work/${PORT}'
ACTDIR parameter == ACTDIR=dirPath TMPDIR parameter == TMPDIR=dirPath PIDFILE parameter == PIDFILE=fileName -- default: ACTDIR='${DGROOT}/act' -- default: TMPDIR=system dependent -- default: PIDFILE='${ACTDIR}/pid/${PORT}'
HOSTS parameter* == HOSTS=nameList[/addrList] nameList == name | {name[,name]*} addrList == addr | {addr[,addr]*} -- default: HOSTS=localhost/127.0.0.1
RESOLV parameter == RESOLV=[resolver[,resolver]*] resolver == resType[:[resParam][:[queryHostList][:clientHostList]]] resType == cache | file | nis | dns | sys -- default: RESOLV=cache,file,nis,dns,sys
cache | -- 以下のレゾルバーによる結果のキャッシュ |
file | -- ローカルの hosts(5) ファイル(一般的に /etc/hosts に配置) |
nis | -- NIS または YP(4) サービスのホストマップ |
dns | -- DNS サービス |
sys | -- gethostbyname() と gethostbyaddr() を使用する (ほとんどの場合、ホストのシステム標準レゾルバーを呼び出す)。 |
cache:/path | -- キャッシュディレクトリーパス名 [$TMPDIR/resolvy] |
file:/path | -- ホスト名ファイルパス名 [/etc/hosts] |
nis:nisDomain | -- NIS ドメイン名 [default domain] |
dns:dnsHost | -- DNS サーバー(のリスト) |
例) 問い合わせられた ホスト/アドレスによって DNS サーバーを選択する
例) 問い合わせる(クライアント) DNS ホストによってレゾルバーを選択する
デフォルトで、複数の IP アドレスを持つホストに接続する場合、 それぞれのレゾルバーで設定された順序に従い、それぞれのアドレスが試されます。 特別なパラメーター HOSTS="*/*/RR"は、"Round Robin" の指定を追加でき、 それら IP アドレスは、 ラウンドロビンの順序で試されます。
RES_WAIT parameter == RES_WAIT=seconds:hostname -- default: RES_WAIT="10:WWW.DeleGate.ORG"
RES_CONF parameter == RES_CONF=URL -- default: RES_CONF="file:/etc/resolv.conf" or from registry (on Windows)
RES_NS parameter == RES_NS=nsList nsList == dnsServ[,nsList] dnsServ == dnsServer[//socksV5Host] | END. -- default: depend on RES_CONF
デフォルトで、"resolv.conf" に 列挙されている nameサーバー は、使用する DNS サーバーの一覧に追加されます。 特別な dnsServ名 ".END" は、それら name サーバーの追加機能を停止します。 例) RES_NS="192.168.1.1,.END" は、192.168.1.1 のみを使用し、 "resolv.conf" を無視することを意味します。
RES_AF parameter == RES_AF=afOrder afOrder == 46 | 64 | 4 | 6 -- default: 46
RES_RR parameter == RES_RR=HostList -- default: RES_RR="*"
RES_VRFY parameter == RES_VRFY="" -- default: none
RES_DEBUG parameter == RES_DEBUG=number -- default: none
ProtoList == [!]protoSpec[,ProtoList] protoSpec == protocolName[/[portNumList][/methodList]]
HostList == [!][-iType]hostSpec[,HostList] iType == {h|a|c|*}/[iType] hostSpec == [{userList}@]hostSpec[/netMask] userList == userNamePattern[,userNamePattern]* hostSpec == hostNamePattern | hostAddrPattern userNamePattern == [*]uname[*] hostNamePattern == [*]hname[*] hostAddrPattern == IPaddressPattern | IPrange netMask == IPaddress | maskLength
"host.yy.xx.dom" のホストは、最初の hostSpec に一致しますが、 2番目で除外されます。しかし、再び、3番目で追加されます。 HostList 中の、最初の host が、"!" をともなう場合、 全宇宙("*"、全てのホスト)から除外されることを意味し、 "!host, ..." は "*,!host,..." とみなされます。
例) 不明ホストや、不明ユーザーからのアクセスを抑制する
例)
例)
period の完全な書式はこのようになります: [wW]HH[MM][-HH[MM]]. 週内の時間制限は、"wW" で表現され、ここでの W は、 "0"(日曜日)から、"6"(土曜日)の範囲です。 利便性のため、日曜日は、"7" でも表現できます。
例)
例)
"+=file" のようなオプションは、オプションのリストが列挙された、 "file" の名前を持つリソースに置換えられ、 "name=+=file" のようなオプションは、 "name=value" リストに置換えられ、 この "value" は、"file" 内に列挙されます。 同様に、"name=xxx:+=file" のようなオプションは、 リスト "name=xxx:value" によって置換えられます。
リソース置換 は、暗号化形式で指定できます。 暗号化されたデータは、書式文字列 "+=enc:ext::XXXX:" として直接表現でき、 XXXX 部は、暗号化されたデータを含みます。 この データ書式は、DeleGate の "-Fenc" オプションで作られます。 ファイル名が ".cdh" 付きの "+=conf.cdh" のようになっているとき、 "Credhy" によって非暗号化され、非暗号化で使用されるパスフェーズは、 "config" ユーザーのパスワードとして指定されます。
置換は、再帰的に実行できます。 この場合、相対リソース名は、 DGPATH または LIBPATH 内で検索されます。 デフォルトで、DGPATH='+:.:${HOME}/delegate'" の "+" は、 "caller" (呼び出し元) リソースの場所を表します。 例)"+=file2" が、呼出元ファイル "/usr/etc/file1" から参照される場合、 "file2" は、"/usr/etc/file2" として、検索されます。 リソース名は、"+={http://host/file1}" や "+={http://host/file}" のように URL で指定できます。
paramRef == +=[URL][?label,[label]*] paramList == line line ... paramListPart == CASE label paramList ESAC
置換リソースは、オプション(または、パラメーター)のリストで、 それぞれの行が一つのオプション(または、パラメーター)を表します。 それぞれの行で、 シャープ (#) に続く文字列は注釈として無視されます。 空白文字キャラクター (SPACE, TAB, LF, CR) が 各行の最初または終わりにある場合、無視されます。 シングルクォート (') および、ダブルクォート (") は取り除かれます。 バックスラッシュ (\) に続く文字はそのままの文字として扱われます。
例) 次の5つの例は、互いに同じ意味を持ちます。
PERMIT=a:b:c PERMIT=a:b:d PERMIT=a:e:f PERMIT=x:y:z ...
置換リソースは、DeleGateが SIGHUP を受けるか、 CRON パラメーターの "-restart" 動作により、 再起動したときに再読込されます。
他の置換 "name=-=URL" は、
URL の内容をローカルファイルシステム上(ACTDIR 内)の一時ファイルに読込み、
そのあとで、パラメーターを "name=/path/of/temporary-file" に書換えます。
これは、"-eCONFIGDATA=-=http://server/configData" のように、
リモートリソースを CGI または、
CFIプログラム経由にしたい場合有効です。
この場合、これらプログラムは、環境変数 CONFIGDATA
("http://server/configData" の内容を含む一時ファイル名を値に持つ) で与えられます。
クライアントと DeleGate 間、または、DeleGate とサーバー間の通信は、
CFI(Common Filter Interface)と呼ばれる簡単な仕組みを用い、
DeleGate に関連付けたユーザー定義フィルタープログラムによって、選択、または、変換できます。
すでに存在するフィルタープログラムが、標準入力から受けて標準出力に出力する場合、
CFI プログラムとして、そのまま使用可能です。
CFI の使用法は、以下のようなパラメーターで制御されます:
filterName="filterSpec"
CMAP="filterSpec":filterName:connMap
filterName == FCL | FTOCL | FFROMCL |
FSV | FTOSV | FFROMSV |
FMD | FTOMD | FFROMMD
filterSpec == filterCommand | CFIscriptName
| tcprelay://host:port
filterName は、
FXX, FTOXX, FFROMXX のような名前で、
XX は CL (クライアント), SV (サーバー),
MD (MASTER-DeleGate) の内の一つです。
FXX のフィルターコマンドは、
クライアントに対して、ファイルディスクリプター 0 がバインドされ、
DeleGate に対しては、ファイルディスクリプター 1 がバインドされます。
FTOXX と FFROMXX
のフィルターコマンドは、標準入力から入力を受け、
XX にバインドされた標準出力へ出力します。
リモートホストの単方向フィルターは、"tcprelay://host:port" により、
TCP 上で接続し使用することができます。
フィルター(サーキットレベル情報において)は 次のように CMAP パラメーターを使うことで、 条件付で利かせることができます:
FTOXX と、FFROMXX フィルターで、
CFI スクリプトは、
データタイプによって、それぞれのデータに適したフィルターを選択して利かせることができます。
FTOCL=filterCommand のような、
直接的使用の代わりに、
FTOCL=filter.cfi を指定でき、
ここでの filter.cfi は、CFI スクリプト形式のファイルです。
また、CFI スクリプトは、FTOCL=URL のように HTTP や FTP 経由で、
リモートホストから読込むこともできます。
CFI スクリプトのファイル名、または、スクリプト中で参照されるフィルターコマンドが、
相対パス名で指定される場合、
それらは LIBPATH 内で検索されます。
CFI スクリプト
CFI スクリプトは、DeleGate 上で転送されるメッセージデータに効かせる
ために使うフィルターを選択(データタイプ、サーバー名、クライアントタイプなどにより)
する簡単なスクリプトです。
CFI スクリプトは、テキストデータで、
"#!cfi" マジックストリングで始まり、
それぞれ "--" によって区切られた
1つ以上のフィルター設計書を含みます。
入力書式:
CFI script == "!#cfi" NL filterUnit [ "--" NL filterUnit ]*
filterUnit == filterRule [ filterRule ]*
filterRule == matchingRule | rewriteRule | filterSpec
matchingRule == matchingName ":" ruleBody
matchingName == MIMEheader | X-header | CGIENV
MIMEheader == "Content-Type" | "User-Agent" | ...
X-header == "X-Status-Ver" | "X-Status-Code"
| "X-Request-Method" | "X-Request-Ver"| "X-Request-URL" | ...
CGIENV == "REQUEST_METHOD" | "SERVER_PROTOCOL" | "SERVER_NAME"
| "PATH_INFO" | "PATH_TRANSLATED" | "HTTP_USER_AGENT" | ...
rewriteRule == Action "/" MIMEheader : ruleBody
Action == "Output" | "Remove"
filterSpec == filterType ":" ruleBody
filterType == "Body-Filter" | "CGI" | "Header-Filter"
| "MIME-Filter" | "Message-Filter"
ruleBody == string NL [ SP string NL ]*
CFI スクリプトへの入力データは、アプリケーションプロトコル
(HTTP, SMTP, POP, NNTP) の要求/応答ステータス行に先行される、
MIME 書式でのアプリケーションプロトコルメッセージです。
ひとつの MIME メッセージは、空行で分離されたヘッダーとボディからなります。
CFIinputMessage == statusLine MIMEheader NL MIMEbody
例) 簡単な HTTP 応答メッセージ
HTTP/1.0 200 OK ... 応答ステータス行 Content-Type: text/html ... ヘッダー Content-Length: 20 ... ヘッダー ... ヘッダー/ボディ 分離行 メッセージボディ ... ボディ
マッチングルール:
matchingRule は、
入力ヘッダーと ruleName:ruleBody を突合わせることを表します。
これは、入力メッセージが ruleBody と一致するフィールドボディを
ともなう ruleName ヘッダーを持つときに一致します。
1つ以上のルールが一致した場合、
真になり、filterUnit が採用されます。
filterUnit 内に突き合わせルールが存在しない場合、
filterUnit は、無条件に採用されます。
現在、限られた MIME ヘッダーセット (要求・応答メッセージ中の) のみが
突き合わせに使用できます。
オリジナルヘッダー中に含まれないいくつかの
拡張ヘッダー情報で突き合わせることもできます。
(例: 応答メッセージ中の状態コードを意味する "X-Status-Code")
CGI
環境変数とのマッチング。
例) マッチングルール
書換えルール:
"Action/" が前置された rewriteRule がある
ruleName:ruleBody は、
関連する ruleName フィールドのための ruleBody データを
使ういくつかの単純な書換えを指定します。
"Output/ruleName:ruleBody" は、
ヘッダーに ruleName:ruleBody フィールドを追加 (または置換)
するということです。
"Remove/ruleName:ruleBody" は、
名前が ruleName で ruleBody と一致するボディを持つ、
ヘッダーフィールドを削除することを表します。
フィルター指定:
filterSpec は、入力データに効かせるフィルターを指定します。
入力メッセージ全体または一部はフィルタープログラムの標準入力へ渡され、
標準出力からのメッセージが元の入力メッセージの代わりに、
対象(クライアントや、サーバー)に転送されます。
Body-Filter: MIMEbody 用フィルター CGI: MIMEbody 用フィルター Header-Filter: MIMEheader 用フィルター MIME-Filter: MIMEheader + MIMEbody 用フィルター Message-Filter: statusLine + MIMEheader + MIMEbody 用フィルター全ての種類のフィルターには、CGI 環境変数が渡されます。 加えて、CFI を起源とする環境変数も渡されます( "SERVER_HOST" (対象サーバー名), "REQUEST_URL" (要求 URL))。
"Body-Filter" や "CGI" のフィルターのために, 転送メッセージ中の "Content-Length" ヘッダーは、フィルター後のボディ部分のサイズを示すように 調整されます。 "CGI" フィルターの出力は、CGI 出力 のステータスヘッダーに先行されていなければなりません。
"Header-Filter" フィルターの場合、 メッセージのヘッダー部はフィルターに渡されます。 HTTP メッセージ (Request-Line または、Status-Line) 中の start-line は、 "Request-Line:" または、"Status-Line:" を 前置きされたヘッダーフィールドとして、渡されます。
"MIME-Filter" のフィルターでは、ヘッダーとボディからなる MIME メッセージ全体が、 フィルターとやりとりされます。
"Message-Filter" のフィルターでは、 アプリケーションプロトコルのメッセージ全体がフィルターとやりとりされ、 それぞれのメッセージは、アプリケーションプロトコルの要求/応答ステータスを 表す 1行を最初に持つ MIME メッセージで構成されます。
例) HTTP 応答メッセージの書換え
例) 利用可能なヘッダーと環境変数を表示する
URL 書換えによるプロキシー動作
U->C:
user opens http://delegate/-_-http://www/path1
C->D: GET /-_-http://www/path1
D->S: GET /path1
D<-S: HREF=/path2
C<-D: HREF=http://delegate/-_-http://www/path2
U->C: user clicks the anchor
C->D: GET /-_-http://www/path2
D->S: GET /path2
S->D: HREF=ftp://ftp/path
D->C: HREF=http://delegate/-_-ftp://ftp/path
元々、この書換え機構は、Gopher プロキシーと、 HTTP プロトコルを拡張するために実装され、 後に、汎用 MOUNT 機構に拡張されました。 現在、ほとんどの "-_-" をともなう宛名書換えと同じ効果は、 次のように、"-_-" と任意文字列の置換え可能にする MOUNT パラメーターに 受け継がれています。
HTML 中に DeleGate のスイッチングテーブルを書くことができます。 もし、異なるネットワークプロバイダなどに接続した、2つの DeleGate ホストがあり、 ブラウザーの設定を変更せず、 "http://delegate/-_-" を前置きした長ったらしいURLを入力せずに、 それらの一つを明示的に選択したい場合。 次のように、HTML 中にテーブルを書込み、DeleGate を選択できます:
このテーブルは、クライアントが DeleGate を使う使わないにかかわらず動作します。 なぜなら、DeleGate は、 上記表現による応答メッセージ中の URL 書換えを行いません (上記のように、すでに URL が書換えられています)。
-_- 印以降の右側には、任意で、 次のように、"/Modifier/" 書式を差込めます:
共通の表記
TCPrelay
例) 同様の役割をする、TCP 上の2つのプロキシー
UDPrelay
例) 同様の役割をする、UDP 上の 2つのプロキシー
例) UDP/TCP 間のゲートウェイ
上記のような一対のゲートウェイは、TCP 接続上で UDP パケットを伝送できますが、 このような中継(トンネリング)は、単一の TCP 接続で SockMux を使用することで、さらに能率的に実現できます。
DGAuth サーバー
例) DGAuth-DeleGate サーバーとそのクライアント
例) DGAuth-DeleGate サーバーと同じホスト上のクライアント
DGAuth サーバーは、各プロトコル用のダイジェスト計算に使用する構成要素一式を受信し、 以下のようにダイジェストを返します。
PAM server
例) PAM-DeleGate サーバーとそのクライアント
例) PAM-DeleGate サーバーとそのクライアントの SSL 上での通信
注記:ほとんどの PAM 認証は Unix 上のスーパーユーザー特権 (OWNER="root" オプションを伴う) で実行することが必要です。 しかし、DGROOT/subin/ に、 外部プログラム "dgpam" をインストールすることで、 スーパーユーザー特権をともなう DeleGate を走らせることを回避できます。
実験 PAM/HTTP サーバー の初期ポート番号は、8686 です。 他のポートは、 AUTHRIZER=-pam//host..port で指定できます。例) AUTHORIZER="-pam//hostX..8765/passwd"
PAM/HTTP プロトコルは、以下のような HTTP 互換の 要求/応答メッセージ書式を使用します。
要求 URL の基点 "/-/pam/" は、PAMCONF="baseurl:/basePath/" で、 任意のパスに置き換えることができます。 要求 URL 全体は、PAMCONF="url:/path" で置き換えられます。 現仕様では、応答メッセージ中の内容は注意されませんが、 将来、いくつかの認証関連情報または、 能力情報は伝達できるようになります。
- 要求:
- GET /-/pam/service/auth HTTP/1.0
Authorization: Basic BASE64of(User:Pass)
- 応答 (以下のいずれか):
- HTTP/1.0 200 OK, authorized
HTTP/1.0 401 Not authorized
HTTP/1.0 403 Forbidden to use the PAM server
次の書式により、あなたは、PAM-DeleGate に代えて、CGI 等を伴う HTTPサーバー などを使用し、PAM サーバーを開発できます。
FTPxHTTP server
YYsh server
YYMUX サーバー
SOCKMUX parameter* == SOCKMUX=host:port:option[,option]* option == acc | con | ssl -- default: none -- status: tentative
host:port は SockMux の持続的接続を確立する 対象のポートを指定します。 接続は、"con" オプションを持つ DeleGate から、 "acc" オプションを持つ DeleGate へ確立されます。
オプション:
例) SockMux 越えで SOCKS プロキシーを連鎖する
例) SockMux 越えで SOCKS プロキシーを連鎖する(サーバー側から接続する)
例) SockMux 越えで HTTP プロキシーを連鎖する
SOXCONF parameter* == SOXCONF=confSpec[,confSpec]* -- default: none
SockMux サーバー
常駐接続は、レセプター側では、"-Phost:port" パラメーター、コネクター側では、 "SERVER=sockmux://host:port" によって生成されます。 外部のリモートへの転送を行うため、接続を受理するポートは、 PORT="listOfPorts パラメーターで指定します。 リモートから内部サーバーへの接続は、接尾文字列 ",-in" を、SERVER="telnet://host:23,-in" のようにつけて指定します。
1つの内部への接続は、指定したプロトコルのプロキシーである DeleGate で処理できます。 プロトコル名が、SERVER="telnet,-in" または "-in" が 接尾された "-in(option list)" のような 指定をした場合のみ、DeleGate は接続処理を呼び出します。 オプションリスト は、起動された DeleGate に コマンドラインオプションリストとして渡されます。 例)SERVER="telnet://host,-in(+=config.cnf)" は、 ``delegated SERVER=telnet://host +=config.cnf'' のような コマンドラインオプションで、DeleGate を起動します。
例) 双方向 SockMux-DeleGate
例) 単方向 SockMux-DeleGate
例)単方向 を proxy-Telent-DeleGate へ
SockMux をソケット間のデータ中継に使用する場合、 アプリケーションプロトコルを解釈せずに SockMux 上を中継します。 このような中継は、SERVER パラメーターの代わりに、 DEST パラメーターを使用することで、以下のように、簡単な表記で表現できます:
例) SockMux 経由の tcprelay
Example: SockMux/TCP 経由で UDP を中継する
これらは、他の方法として、名前付パイプのような単一の FIFO デバイスを使用し 2つの SockMux-DeleGate 間の常駐接続を作ります。 それは、SERVER=sockmux:commtype@fifoName のように指定し、 この、commtype は、"commin", "commout", "comm" の内一つで、 それぞれ、単方向入力,単方向出力,双方向入出力を表します。
例)ホスト上の FIFO デバイスを使用する。
例)2ホスト間の通信ポートを使用する (未テスト)
常駐接続は DeleGate により起動された外部プログラムにより生成できます。 プログラムの処理は、 ファイルディスクリプター番号 0 および、1 で DeleGate とのソケット でやり取りされます;
例) 外部コマンドを使用して接続を開始する。
リモートから内部への接続するための対象サーバーは、 受け付けたリモートポートによって選択できます。 SERVER パラメーターに、 ":-:-Pxxxx" を後置することで、PORT=xxxx によりリモートホスト上で 受け付けられた接続にのみ有効になります。
例)複数のポートを転送する
注記)FTP データ接続の転送は、(まだ)サポートされません。
HTMUX parameter == HTMUX=sv[:[hostList][:portList]] | HTMUX=cl:host:port | HTMUX=px:host:port -- 制限: CAPSKEY が必要 -- default: none
標準で、入ってくる接続だけでなく、HTMUX クライアントから出てゆく接続も HTMUX サーバー経由で達成されます。 これは、内部サーバーへ入ってくる要求を転送する DeleGate には不要でしょう。 例えば、このようなケースでは、CONNECT="direct:*:192.168.1.*" のように CONNECT パラメーターを使って、そのような接続を直接的に確立するように指定します。
例)
この例では、hostX は、プライベートアドレス 192.168.1.1 とグローバルアドレス xx.xx.xx.xx を持つマルチホームホストであることを表しています。 hostX 上の DeleGate は、HTMUX サーバーとして機能しています。 hostI 上の HTTP DeleGate と、hostJ 上の FTP DeleGate は、 HTMUX クライアントとして機能していて、hostX 上の HTMUX サーバー経由で、 (xx.xx.xx.xx に来た) 要求を遠隔で受け付けています。
一対の HTMUX サーバー/クライアントは、SockMux プロトコルによって多重化された 複数の並列接続をリレーする単一の持続的接続を使います。 この機能は、入ってくる接続がファイアーウォール上の制限をすり抜けでくるような 悪意を持った使われかたをされてはいけません。 ですので、この機能を有効にするには、CAPSKEY を導入する必要があります。 HTMUX で他に標準で無効になっているのは、 クライアントサーバー間の間接接続(NAT やプロキシー経由の接続)、 クライアントサーバー間の大きすぎる時間のずれ(初期値は300秒)、 クライアントサーバー間に挿入された SSL 暗号化です。
HTMUX のための間接接続を有効にするには2通りの方法があります。
ひとつは、CAPSKEY を導入して、間接 HTMUX 接続を有効にする。
もうひとつは、下記例のように HTMUX プロキシーを挟む事です。
例) HTMUX を HTMUX プロキシーとともにカスケードする
HTMUX クライアントサーバー間の持続的な接続は、双方向接続を搬送できますので、 それ上に一対のプロキシーを形成できます。 各プロキシーは、以下の例のようにローカルポートで要求を受け付けて遠隔のプロキシーに転送します。
例) HTMUX を対称性を持つプロキシーにして使う(もっとも簡単な汎用的な設定)
この例で、-P8080 はワイルドカードアドレス表現 "-P*:8080" と同じで、
ホスト上の全インターフェースのポート番号 8080 から受け付けます。
ですので、hostX 上の任意のインターフェース上のポート 8080 への要求は、
HTMUX クライアント(および HTTP プロキシー)としての hostX 上の DeleGate 経由
でサーバーに転送されます。
対称的に hostY 上の任意のインターフェース上のポート 8080 への要求は、
HTTP プロキシー(および hostX:9876 での HTMUX サーバ)としての hostX 上の
DeleGate 経由でサーバーに転送されます。
(今一度、標準でこの機能は無効になっており、有効にするには CAPSKEY
が必要です。)
サーバー側とクライアント側で使うポートは、-P または -Q オプションに "/local" と "/remote" 修飾子を使う事で別々に指定できます。 "/local" は、ポートをローカルホスト上で使う(HTMUX クライアントで)事を明示し、 "/remote" は、ポートをリモートホスト上で使う(HTMUX サーバー)事を明示します。 上記例の "-P8080" の指定は、"-P*:8080/remote,*:8080/local" と同じです。
例) HTMUX を双方向に使う
この例で、hostX と hostI 間で、 それぞれのホスト上の localhost:8081 への要求は、 対向に転送されます ("-Plocalhost:8081/remote,localhost:8081/local" と同じ)。 hostX と hostJ 間で、 hostX:8082 and hostJ:8083 は、対向に転送されます ("-PhostX:8082/remote,hostJ:8083/local" と同じ)。
例) HTMUX を外向けの要求にのみ使う。
これは、HTMUX を外向けの要求にのみ使う例です。 HTMUX パラメータがなくても動きますが、HTMUX により、サーバークライアント間では、 単一の持続的接続が使われます。 この HTMUX の使いかたは DeleGate がフォアグラウンド動作しているとき (-fv オプションを伴い、サービスやデーモンとしてではなく) に上記制限や CAPSKEY 無しで、標準で使えます。
CAPSKEY parameter* == CAPSKEY=opaque -- default: none
Socks サーバー
例) Socks-DeleGate
Socks-DeleGate サーバー経由で内向けの TCP 接続を許可する場合、 そのために使用されるネットワークインターフェースは、DeleGate が自動的に選択します (DST.ADDR または、SOCKS クライアントから BIND コマンドのパラメーターとして送られた、DSTIP を基準として)。 SRCIF を指定した場合、擬似プロトコル名 "tcpbind" と共に、 ネットワークインターフェース(およびポート番号)を指定できます。 パラメーターの完全な書式は、 SRCIF= "[host]:[port]:tcpbind[:dstHostList[:srcHostList]]" となります。 通常、host フィールドには、選択するネットワークインターフェースのみを、 SRCIF="150.29.202.120::tcpbind" のように指定します。
注記: DeleGate を、他の SOCKS サーバーと連結する時、UDP リレーで、 DeleGate によって、内部的に仮に拡張された SOCKS プロトコルに起因する、問題が発生するかもしれません。 そのような問題を回避するために以下の SRCIF パラメーターが使えます。
SOCKSTAP parameter* == SOCKSTAP=ProtoList[:[dstHostList][:[srcHostList][:params]]] -- default: none
例) HTTP と FTP でキャッシュを行う Socks-DeleGate
例) 上流プロキシーとともに、HTTP のキャッシュを行う Socks-DeleGate
See http://www.delegate.org/delegate/sockstap/> for more details.
HTTP プロキシー/サーバー
この DeleGate を内部ホスト上のクライアントから使う場合、 HTTP, HTTPS (Security), FTP, Gopher, Wais などの プロキシーに "firewall:8080" を指定します。
例) 多段 HTTP プロキシー DeleGate
内部ホストからの要求のみ受け付ける generalist DeleGate を firewall 上で走らせ、firewall ホスト上の generalist を使用する、 specialist を内部で、走らせる。 generalistは、上流 DeleGate として、 任意プロトコルの複数の DeleGate で共有できます。
例) 元 HTTP サーバー DeleGate
例) DeleGate を CGI プログラムとして使う
HTTP 伝送ログ書式
%C | -- CERN-HTTPD の共通ログファイル書式 |
%c | -- ミリ秒解像度を持った日付が記録されるのを除き、%C と同じ |
%D | -- DeleGate による拡張 (connTime+relayTime:status) |
%X | == '%C "%r" "%u"' Referer と User-Agent付きの共通ログファイル書式 |
%r | -- 要求メッセージ中の Referer フィールド |
%u | -- 要求メッセージ中の User-Agent フィールド |
%S | -- サーバーへの CONNECT ステータス (c,m,p,d,s,v) |
%s | -- HTTPCONF=session によるセッション ID |
%As | -- ダイジェスト認証中のセッション ID |
%{field} | -- 要求メッセージ中の任意のフィールド |
"%s" により出されるセッション識別子は、 AUTHORIZER=-dgauth オプションによって生成された "%As" の間、 HTTPCONF=session:cookie によって生成されています。 セッション識別子の書式:
例) "031114-173045.1234.5+6+7.9" は、PID=1234 のプロセスによって、 November 14 の 17:30:45 に開始されたセッション中での クライアントからの 9回目の要求であることを意味します。 セッションの開始は、LOGFILE にこのように記録されます。
注記: reqnum 部分は、並列、または、パイプライン 要求がセッション所有者であるクライアントによって生成された場合、 ユニークではありません。 注記: "%As" 用の reqnum 部は、それぞれの要求で加算されないかもしれません。 なぜなら、セッション識別子のコンテナー (この場合、ダイジェスト認証の "opaque" パラメーター) が、それぞれの要求で更新されないかもしれないからです。
HTTPCONF parameter == HTTPCONF=what:conf
MOUNT パラメーターの中から仮想サーバーを自動的に検出し、それらを仮想サーバーだけに
適用する MOUNT ルールとして表します。
これは、各 MOUNT パラメーターの "nvserv" マウントオプションで
指定することで、手動で実行できます。
"nvserv:alias" は、共通の IP アドレスを持つ対象サーバー郡のホスト名を検出し、
それらを仮想サーバーとして表します。
"nvserv:gen" は、"genvhost" マウントオプション付きの MOUNT パラメーターを仮想サーバーとして
表します。
"nvserv:auto" は、"nvserv:alias,gen" と等価です。
推測による自動検出は、avserv マウントオプションを明示的に指定することで
上書きできます。
"nvserv:none" は、自動検出された、または "nvserv" マウントオプションで明示的に指定された、
仮想サーバーに対する全ての取扱いを無効にします。
例)
例)
例)
クライアントに保存される Set-Cookie 応答内の指定した属性を暗号化し、後で、 復号し、Cookie 発行元だけに Cookie 要求を転送します。 Cookie 内の属性は、"attribute@host" または "attribute@.domain" で指定します。 前者では、host で生成された cookie は暗号化され、 host にだけ、エコー(返され)されます。 後者では、domain 内のホストで生成された cookie を、 domain 内のホストにエコー(返せ)せます。 cryptKey 内の特殊文字列 "%a" は、 クライアントの IP アドレスに置き換えられます。 これは、その IP アドレスを持つホスト上のクライアントからのみ 暗号化 Cookie を使えるようにします。
例)
例)
例)
HTTPCONF="add-qhead:X-Forward-For:%a"
例)
例)
例)
例)
FILETYPE parameter == FILETYPE=suffix:gopherType:altText:iconName:contentType -- default: FILETYPE=".txt:0:TXT:text:text/plain" FILETYPE=...
例)
CGIENV parameter == CGIENV=name[,name]* -- default: CGIENV="*"
HTTP-DeleGate 用のマウントオプション
制御:
例) 仮想ホスティング,複数の HTTP サーバーとして動作する
MOUNT="/* http://wwwA/* nvhost=dom1.com"
MOUNT="/* http://wwwB/* nvhost=dom2.org"
MOUNT="/* file:data/wwwC/* nvhost=dom3.net"
MOUNT="/* file:data/www/*"
例)
HTTP-DeleGate 用 AUTH パラメーター
例)
%u | -- Ident プロトコルで得られたユーザー名 |
%h | -- ソケットから得られたクライアントのホスト名 |
%i | -- クライアントに向けたネットワークインターフェースのホスト名 |
%I | -- %i と同様ですが、HTTP で "Host:" が与えられた場合その値を使用します。 |
%a | -- クライアントのホストアドレス |
%n | -- クライアントのネットワークアドレス |
%H | -- DeleGate のホスト名 |
%M | -- DeleGate の ADMIN |
%A | -- "CMAP=string:authgen:mapSpec" によって生成される文字列 |
%U | -- クライアントの [Proxy-]Authorization: username:password の username 部 |
%P | -- クライアントの [Proxy-]Authorization: username:password の password 部 |
例)
"passWord/%i" 書式でパスワードが生成され、DeleGate は、 このようなパターンの Authorization フィールドをともなってくる要求を拒否します。 このように、偽パスワードは、ホスト"%i" 上の DeleGate を通過できません。
例)
%F | -- From フィールドの E-mail アドレス |
%L | -- From: local@domain フィールドの local 部 |
%D | -- From: local@domain フィールドの domain 部 |
%U | -- Authorization: username:password の username 部 |
%P | -- Authorization: username:password の password 部 |
%Q | -- Forwarded: フィールドの "for clientFQDN" 部 |
例)
ユーザーによる DeleGate の設定
例) ニュースサーバー N を、http://delegate/news/servN/ に MOUNT する
(この機能は、FTP のような他のプロトコルに適用するべきです...)
SSI タグ
注)クライアントユーザーに対する DeleGate(元サーバーまたはプロキシー)
による通常のアクセス制御下の SSI によるリソースが含まれます。
それは含まれるリソースのアクセスが拒否されます。
SSI-include 経由でも拒否されます。
virtual=http://exserver/dir/fileX のような DeleGate サーバーの管轄外リソースを含むことを許可するのは
SHTML 書込みのようにユーザーによるセキュリティーホールを作ります。
元サーバーのとき、SSI-includeプロキシーとしての転送は RELAY=no によって拒否される必要がありますが、
他のサーバーからでも SSI-include で拒否されます。
バージョン9での簡単な方法は
RELAY="proxy:http:exserver:*"
のように制限した RELAY を追加することで、exserver のみへのリレーを許可します。
他の安全な方法は、
MOUNT="/ex/* http://exserver/dir/*" の後に
virtual="/ex/fileX" のような SSL-include を書きます。
しかしながら、双方とも exserver の意図された仮想 URL 外のリソースに
アクセスすることをクライアントユーザーに許可します。
バージョン10 において上記問題の対処するため、RELAY=no とともに使う RELAY=ssi が追加されました。
RELAY=ssi は SHTML を書く者に他のサーバーからの物を追加でき、
クライアントユーザーの許可は変化しません(RELAY=no と同じ)。
RELAY=ssi 無しで言えば、あなた(DeleGate 管理者としての)は SHTML を書く者が
他のサーバーを含めるのを防げます。
RELAY=ssi:protocolList:serverList:clientList
のような DeleGate の汎用表記で追加可能な対象サーバー(プロトコル、クライアントも)
を制限することもできます。
注)多分、プラットフォームや言語によらない方法で任意のサーバーにアクセスする CGI を禁止することは不可能です。
ですが、少なくとも、
REMITTABLE="+,-cgi".
で CGI 自体を禁止することができます。
バージョン10 での他の(そしてもっと重要かもしれない)拡張は、SSI-include 経由の
サーバーとクライアント間前後の要求・応答メッセージヘッダ(Cookie や User-Agent)をリレーすることです。
META タグ