nodejs.org_ja/api/https.html at master · nodejsjp/nodejs.org_ja

487 lines (415 loc) · 19.3 KB
<!doctype html>
<html lang="ja">
  <meta charset="utf-8">
  <title>HTTPS Node.js v0.11.11 Manual &amp; Documentation</title>
  <link rel="stylesheet" href="assets/style.css">
  <link rel="stylesheet" href="assets/sh.css">
  <link rel="canonical" href="http://nodejs.org/api/https.html">
<body class="alt apidoc" id="api-section-https">
    <div id="intro" class="interior">
        <a href="/" title="Go back to the home page">
            <img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js">
        </a>
    <div id="content" class="clearfix">
        <div id="column2" class="interior">
            <ul>
                <li><a href="/" class="home">Home</a></li>
                <li><a href="/download/" class="download">Download</a></li>
                <li><a href="/about/" class="about">About</a></li>
                <li><a href="http://npmjs.org/" class="npm">npm Registry</a></li>
                <li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li>
                <li><a href="http://blog.nodejs.org" class="blog">Blog</a></li>
                <li><a href="/community/" class="community">Community</a></li>
                <li><a href="/logos/" class="logos">Logos</a></li>
               <li><a href="../" class="home">ホーム</a></li>
               <li><a href="../#download" class="download">ダウンロード</a></li>
               <li><a href="../about/" class="about">概要</a></li>
               <li><a href="http://npmjs.org/" class="npm">npm レジストリ</a></li>
               <li><a href="../api/" class="docs current">ドキュメント</a></li>
               <li><a href="http://blog.nodejs.org" class="blog">ブログ</a></li>
               <li><a href="../community/" class="community">コミュニティ</a></li>
               <li><a href="../logos/" class="logos">ロゴ</a></li>
                <li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li>
            </ul>
            <p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p>
        </div>
        <div id="column1" class="interior">
          <header>
            <h1>Node.js v0.11.11 マニュアル &amp; ドキュメンテーション</h1>
            <div id="gtoc">
                <a href="index.html" name="toc">Index</a> |
                <a href="all.html">View on single page</a> |
                <a href="https.json">View as JSON</a>
              </p>
            </div>
            <hr>
          </header>
          <div id="toc">
            <h2>Table of Contents</h2>
            <ul>
<li><a href="#https_https">HTTPS</a><ul>
<li><a href="#https_class_https_server">Class: https.Server</a><ul>
<li><a href="#https_server_settimeout_msecs_callback">server.setTimeout(msecs, callback)</a></li>
<li><a href="#https_server_timeout">server.timeout</a></li>
<li><a href="#https_server_listen_port_host_backlog_callback">server.listen(port, [host], [backlog], [callback])</a></li>
<li><a href="#https_server_listen_path_callback">server.listen(path, [callback])</a></li>
<li><a href="#https_server_listen_handle_callback">server.listen(handle, [callback])</a></li>
<li><a href="#https_server_close_callback">server.close([callback])</a></li>
<li><a href="#https_https_request_options_callback">https.request(options, callback)</a></li>
<li><a href="#https_https_get_options_callback">https.get(options, callback)</a></li>
<li><a href="#https_class_https_agent">Class: https.Agent</a></li>
<li><a href="#https_https_globalagent">https.globalAgent</a></li>
          </div>
          <div id="apicontent">
            <h1>HTTPS<span><a class="mark" href="#https_https" id="https_https">#</a></span></h1>
<pre class="api_stability_3">Stability: 3 - Stable</pre><!--
HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
separate module.
<p>HTTPS は TLS/SSL 上の HTTP プロトコルです。
Node ではこれらは別のモジュールとして実装されています。
<h2>Class: https.Server<span><a class="mark" href="#https_class_https_server" id="https_class_https_server">#</a></span></h2>
This class is a subclass of `tls.Server` and emits events same as
`http.Server`. See `http.Server` for more information.
<p>このクラスは <code>tls.Server</code> のサブクラスで、<code>http.Server</code> と同様のイベントを生成します。
より詳しくは <code>http.Server</code> を参照してください。
<h3>server.setTimeout(msecs, callback)<span><a class="mark" href="#https_server_settimeout_msecs_callback" id="https_server_settimeout_msecs_callback">#</a></span></h3>
See [http.Server#setTimeout()][].
<p><a href="http.html#http_server_settimeout_msecs_callback">http.Server#setTimeout()</a> を参照してください。
<h3>server.timeout<span><a class="mark" href="#https_server_timeout" id="https_server_timeout">#</a></span></h3>
See [http.Server#timeout][].
[http.Server#timeout][] を参照してください。
## https.createServer(options, [requestListener])
Returns a new HTTPS web server object. The `options` is similar to
[tls.createServer()][].  The `requestListener` is a function which is
automatically added to the `'request'` event.
<p>新しい HTTPS Web サーバオブジェクトを返します。
<code>option</code> は <a href="tls.html#tls_tls_createserver_options_secureconnectionlistener">tls.createServer()</a> と同じです。
<code>requestListener</code> は関数で、 <code>&#39;request&#39;</code> イベントに自動的に追加されます。
<pre><code>// curl -k https://localhost:8000/
var https = require(&#39;https&#39;);
var fs = require(&#39;fs&#39;);
var options = {
  key: fs.readFileSync(&#39;test/fixtures/keys/agent2-key.pem&#39;),
  cert: fs.readFileSync(&#39;test/fixtures/keys/agent2-cert.pem&#39;)
https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end(&quot;hello world\n&quot;);
}).listen(8000);</code></pre>
<pre><code>var https = require(&#39;https&#39;);
var fs = require(&#39;fs&#39;);
var options = {
  pfx: fs.readFileSync(&#39;server.pfx&#39;)
https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end(&quot;hello world\n&quot;);
}).listen(8000);</code></pre>
<h3>server.listen(port, [host], [backlog], [callback])<span><a class="mark" href="#https_server_listen_port_host_backlog_callback" id="https_server_listen_port_host_backlog_callback">#</a></span></h3>
<h3>server.listen(path, [callback])<span><a class="mark" href="#https_server_listen_path_callback" id="https_server_listen_path_callback">#</a></span></h3>
<h3>server.listen(handle, [callback])<span><a class="mark" href="#https_server_listen_handle_callback" id="https_server_listen_handle_callback">#</a></span></h3>
See [http.listen()][] for details.
<p>詳細は <a href="http.html#http_server_listen_port_hostname_backlog_callback">http.listen()</a> を参照してください。
<h3>server.close([callback])<span><a class="mark" href="#https_server_close_callback" id="https_server_close_callback">#</a></span></h3>
<p>See <a href="http.html#http_server_close_callback">http.close()</a> for details.
<p>詳細は <a href="http.html#http_server_close_callback">http.close()</a> を参照してください。
<h2>https.request(options, callback)<span><a class="mark" href="#https_https_request_options_callback" id="https_https_request_options_callback">#</a></span></h2>
Makes a request to a secure web server.
<p>セキュアな Web サーバへのリクエストを作成します。
`options` can be an object or a string. If `options` is a string, it is
automatically parsed with [url.parse()](url.html#url.parse).
<p><code>options</code> はオブジェクトまたは文字列です。
<code>options</code> が文字列なら、それは自動的に <a href="url.html#url.parse">url.parse()</a>
によって解析されます。
All options from [http.request()][] are valid.
<p><a href="http.html#http_http_request_options_callback">http.request()</a> の全てと同様のオプションが指定できます。
<pre><code>var https = require(&#39;https&#39;);
var options = {
  hostname: &#39;encrypted.google.com&#39;,
  port: 443,
  path: &#39;/&#39;,
  method: &#39;GET&#39;
var req = https.request(options, function(res) {
  console.log(&quot;statusCode: &quot;, res.statusCode);
  console.log(&quot;headers: &quot;, res.headers);
  res.on(&#39;data&#39;, function(d) {
    process.stdout.write(d);
req.on(&#39;error&#39;, function(e) {
  console.error(e);
});</code></pre>
The options argument has the following options
<p><code>options</code> 引数は以下のオプションを持ちます。
- `host`: A domain name or IP address of the server to issue the request to.
  Defaults to `'localhost'`.
- `hostname`: To support `url.parse()` `hostname` is preferred over `host`
- `port`: Port of remote server. Defaults to 443.
- `method`: A string specifying the HTTP request method. Defaults to `'GET'`.
- `path`: Request path. Defaults to `'/'`. Should include query string if any.
  E.G. `'/index.html?page=12'`
- `headers`: An object containing request headers.
- `auth`: Basic authentication i.e. `'user:password'` to compute an
  Authorization header.
- `agent`: Controls [Agent][] behavior. When an Agent is used request will
  default to `Connection: keep-alive`. Possible values:
 - `undefined` (default): use [globalAgent][] for this host and port.
 - `Agent` object: explicitly use the passed in `Agent`.
 - `false`: opts out of connection pooling with an Agent, defaults request to
   `Connection: close`.
<li><code>host</code>: リクエストを発行するサーバのドメイン名または IP アドレス。</li>
<li><code>hostname</code>: <code>url.parse()</code> で扱える文字列をサポートします。
<code>hostname</code> は <code>host</code> を上書きします。</li>
<li><code>port</code>: リモートサーバのポート。デフォルトは 443 です。</li>
<li><code>method</code>: HTTPS リクエストのメソッドの文字列。デフォルトは <code>&#39;GET&#39;</code> です。</li>
<li><code>path</code>: リクエストのパス。デフォルトは <code>&#39;/&#39;</code> です。
必要なら問い合わせ文字列を含めるべきです．
例 <code>&#39;/index.html?page=12&#39;</code></li>
<li><code>headers</code>: リクエストヘッダを含むオブジェクト。</li>
<li><code>auth</code>: べーしく認証すなわち Authorization ヘッダのための <code>&#39;user:password&#39;</code>。</li>
<li><code>agent</code>: <a href="#https_class_https_agent">Agent</a> の振る舞いを制御します。
エージェントが使われる場合、<code>Connection:keep-alive</code> がデフォルトになります。
<li><code>undefined</code> (デフォルト): ホストとポートで <a href="#https_https_globalagent">globalAgent</a> を使用します。</li>
<li><code>Agent</code> オブジェクト: 明示的に渡された <code>Agent</code> を使用します。</li>
<li><code>false</code>: Agent によるコネクションプーリングを使用しません。
<code>Connection:close</code> の場合のデフォルトです。</li>
The following options from [tls.connect()][] can also be specified. However, a
[globalAgent][] silently ignores these.
<p>以下の <a href="tls.html#tls_tls_connect_options_callback">tls.connect()</a> 由来のオプションを指定することもできますが、
グローバル <a href="#https_https_globalagent">globalAgent</a> はこれらを無視します。
- `pfx`: Certificate, Private key and CA certificates to use for SSL. Default `null`.
- `key`: Private key to use for SSL. Default `null`.
- `passphrase`: A string of passphrase for the private key or pfx. Default `null`.
- `cert`: Public x509 certificate to use. Default `null`.
- `ca`: An authority certificate or array of authority certificates to check
  the remote host against.
- `ciphers`: A string describing the ciphers to use or exclude. Consult
  <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT> for
  details on the format.
- `rejectUnauthorized`: If `true`, the server certificate is verified against
  the list of supplied CAs. An `'error'` event is emitted if verification
  fails. Verification happens at the connection level, *before* the HTTP
  request is sent. Default `true`.
- `secureProtocol`: The SSL method to use, e.g. `SSLv3_method` to force
  SSL version 3. The possible values depend on your installation of
  OpenSSL and are defined in the constant [SSL_METHODS][].
<li><code>pfx</code>: SSL で使用する証明書、秘密鍵、認証局の証明書。
 デフォルトは <code>null</code> です。</li>
<li><code>key</code>: SSL で使用する秘密鍵。デフォルトは <code>null</code> です。</li>
<li><code>passphrase</code>: 秘密鍵または pfx のパスフレーズを表す文字列。
 デフォルトは <code>null</code> です。</li>
<li><code>cert</code>: x509公開証明書。デフォルトは <code>null</code> です。</li>
<li><code>ca</code>: リモートホストをチェックする信頼できる認証局または認証局の配列。</li>
<li><code>ciphers</code>: 使用または除外する暗号を記述した文字列。
詳細は <a href="http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT">http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT</a>
を参照してください。</li>
<li><code>rejectUnauthorized</code>: <code>true</code> の場合、サーバ証明書は提供された認証局の
リストによって検証されます。
認証されなかった場合は <code>&#39;error&#39;</code> イベントが生成されます。
認証は HTTP リクエストが送信される <em>前</em> にコネクションレベルで行われます。
デフォルトは <code>true</code> です。</li>
<li><code>secureProtocol</code>: 使用する SSL メソッド、たとえば <code>SSLv3_method</code> は
SSL version 3 の使用を強制します。可能な値は使用する OpenSSL によって
定義される <a href="http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS">SSL_METHODS</a> 定数に依存します。</li>
In order to specify these options, use a custom `Agent`.
<p>これらのオプションを指定するには、カスタムエージェントを使用します。
<pre><code>var options = {
  hostname: &#39;encrypted.google.com&#39;,
  port: 443,
  path: &#39;/&#39;,
  method: &#39;GET&#39;,
  key: fs.readFileSync(&#39;test/fixtures/keys/agent2-key.pem&#39;),
  cert: fs.readFileSync(&#39;test/fixtures/keys/agent2-cert.pem&#39;)
options.agent = new https.Agent(options);
var req = https.request(options, function(res) {
}</code></pre>
Or does not use an `Agent`.
<p>あるいは、エージェントを使用しません。
<pre><code>var options = {
  hostname: &#39;encrypted.google.com&#39;,
  port: 443,
  path: &#39;/&#39;,
  method: &#39;GET&#39;,
  key: fs.readFileSync(&#39;test/fixtures/keys/agent2-key.pem&#39;),
  cert: fs.readFileSync(&#39;test/fixtures/keys/agent2-cert.pem&#39;),
  agent: false
var req = https.request(options, function(res) {
}</code></pre>
<h2>https.get(options, callback)<span><a class="mark" href="#https_https_get_options_callback" id="https_https_get_options_callback">#</a></span></h2>
Like `http.get()` but for HTTPS.
<p><code>http.get()</code> と同様ですが HTTPS です。
`options` can be an object or a string. If `options` is a string, it is
automatically parsed with [url.parse()](url.html#url.parse).
<p><code>options</code> はオブジェクトまたは文字列です。
<code>options</code> が文字列なら、それは自動的に <a href="url.html#url.parse">url.parse()</a>
によって解析されます。
<pre><code>var https = require(&#39;https&#39;);
https.get(&#39;https://encrypted.google.com/&#39;, function(res) {
  console.log(&quot;statusCode: &quot;, res.statusCode);
  console.log(&quot;headers: &quot;, res.headers);
  res.on(&#39;data&#39;, function(d) {
    process.stdout.write(d);
}).on(&#39;error&#39;, function(e) {
  console.error(e);
});</code></pre>
<h2>Class: https.Agent<span><a class="mark" href="#https_class_https_agent" id="https_class_https_agent">#</a></span></h2>
An Agent object for HTTPS similar to [http.Agent][].  See [https.request()][]
for more information.
<p>HTTPS 用の Agent オブジェクトで，<a href="http.html#http_class_http_agent">http.Agent</a> と同様です。
詳細は <a href="#https_https_request_options_callback">https.request()</a> を参照してください。
<h2>https.globalAgent<span><a class="mark" href="#https_https_globalagent" id="https_https_globalagent">#</a></span></h2>
Global instance of [https.Agent][] for all HTTPS client requests.
<p>全ての HTTPS クライアントリクエストで使用される、デフォルトの
<a href="#https_class_https_agent">https.Agent</a> のインスタンスです。
          </div>
        </div>
    <div id="footer">
        <a href="http://joyent.com" class="joyent-logo">Joyent</a>
        <ul class="clearfix">
            <!--
            <li><a href="/">Node.js</a></li>
            <li><a href="/download/">Download</a></li>
            <li><a href="/about/">About</a></li>
            <li><a href="http://npmjs.org/">npm Registry</a></li>
            <li><a href="http://nodejs.org/api/">Docs</a></li>
            <li><a href="http://blog.nodejs.org">Blog</a></li>
            <li><a href="/community/">Community</a></li>
            <li><a href="/logos/">Logos</a></li>
            <li><a href="../">Node.js</a></li>
            <li><a href="../#download">ダウンロード</a></li>
            <li><a href="../about/">概要</a></li>
            <li><a href="http://npmjs.org/">npm レジストリ</a></li>
            <li><a href="../api/">ドキュメント</a></li>
            <li><a href="http://blog.nodejs.org">ブログ</a></li>
            <li><a href="../community/">コミュニティ</a></li>
            <li><a href="../logos/">ロゴ</a></li>
            <li><a href="http://jobs.nodejs.org/">Jobs</a></li>
            <li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
        </ul>
        <p>Copyright <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="/trademark-policy.pdf">trademark</a> of Joyent, Inc. View <a href="https://raw.github.com/joyent/node/v0.11.11/LICENSE">license</a>.</p>
  <script src="../sh_main.js"></script>
  <script src="../sh_javascript.min.js"></script>
  <script>highlight(undefined, undefined, 'pre');</script>
    window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']];
    (function(d, t) {
      var g = d.createElement(t),
          s = d.getElementsByTagName(t)[0];
      g.src = '//www.google-analytics.com/ga.js';
      s.parentNode.insertBefore(g, s);
    }(document, 'script'));
  </script>
Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

https.html

Latest commit

History

https.html

File metadata and controls
