send_request_cgi / request_cgi に渡せる主なオプションです。参照元は Rex::Proto::Http::Client#request_raw / #request_cgi と HttpClient 本体です。
| キー | 型 | 意味 | 既定値の目安 |
|---|
method | String | HTTP メソッド | GET |
uri | String | パス | 必須相当 |
version | String | HTTP 版 | 1.1 |
proto | String | プロトコル名 | HTTP |
vhost | String | Host ヘッダ | datastore VHOST / rhost |
rhost | String | 接続先ホストの上書き | datastore |
rport | Integer | 接続先ポート上書き | datastore |
SSL | Bool | TLS 上書き | datastore |
agent | String | User-Agent | datastore UserAgent |
connection | String | Connection ヘッダ | |
encode | Bool | URI 自体のエンコード | false |
partial | Bool | 不完全応答も返す | false |
| キー | 型 | 意味 |
|---|
vars_get | Hash | クエリパラメータ |
vars_post | Hash | フォーム POST パラメータ |
vars_form_data | Array<Hash> | multipart フィールド配列 |
vars_form_data_boundary | String | multipart boundary(通常は自動) |
query | String | 生のクエリ文字列(vars_get の代替) |
data | String | 生の本文 |
ctype | String | Content-Type |
encode_params | Bool | GET / POST パラメータの URI エンコード(既定値 true) |
| キー | 型 | 意味 |
|---|
headers | Hash | 追加ヘッダ |
raw_headers | String | 生ヘッダ文字列 |
authorization | String | Authorization ヘッダ値 |
cookie | String / HttpCookieJar | Cookie ヘッダ |
keep_cookies | Bool | Set-Cookie を Cookie jar へ取り込む |
expire_cookies | Bool | Cookie jar の期限切れ項目を使用前に削除する(既定で有効、false で無効化) |
username / password | String | クライアント認証用(接続時) |
preferred_auth | String | Basic / Digest / NTLM / Kerberos / Negotiate / None |
リクエスト Hash ではなく、モジュールオプションとして効くものです。
| オプション | 効果 |
|---|
HttpUsername / HttpPassword | 接続時のユーザ認証情報 |
HttpClientTimeout | タイムアウト秒 |
HttpTrace / HttpTraceHeadersOnly | デバッグ出力 |
HttpRawHeaders | ERB テンプレの追加ヘッダファイル |
UserAgent | 既定 UA |
DOMAIN | NTLM / Kerberos |
HTTP::Auth | 認証方式 |
HTTP::uri_encode_mode など | 回避用の設定 |
'vars_get' => { 'a' => '1' },
'headers' => { 'Accept' => 'text/plain' },