<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.exec.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.escapeshellcmd.php',
    1 => 'escapeshellcmd',
    2 => 'シェルのメタ文字をエスケープする',
  ),
  'up' => 
  array (
    0 => 'ref.exec.php',
    1 => 'プログラム実行関数',
  ),
  'prev' => 
  array (
    0 => 'function.escapeshellarg.php',
    1 => 'escapeshellarg',
  ),
  'next' => 
  array (
    0 => 'function.exec.php',
    1 => 'exec',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/exec/functions/escapeshellcmd.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.escapeshellcmd" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">escapeshellcmd</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">escapeshellcmd</span> &mdash; <span class="dc-title">シェルのメタ文字をエスケープする</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.escapeshellcmd-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>escapeshellcmd</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$command</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>escapeshellcmd()</strong></span> は、文字列中においてシェルコマンドを
   だまして勝手なコマンドを実行する可能性がある文字をエスケープします。
   この関数は、ユーザーに入力されたデータを関数
   <span class="function"><a href="function.exec.php" class="function">exec()</a></span> または <span class="function"><a href="function.system.php" class="function">system()</a></span> または、
   <a href="language.operators.execution.php" class="link">バッククォート演算子</a>
   に渡す前に全てエスケープを行う場合に使用するべきです。
  </p>
  <p class="para">
   <code class="literal">&amp;#;`|*?~&lt;&gt;^()[]{}$\</code>、<code class="literal">\x0A</code>
   および <code class="literal">\xFF</code> については、その文字の前にバックスラッシュが
   追加されます。<code class="literal">&#039;</code> および <code class="literal">&quot;</code>
   は、対になっていない場合にのみエスケープされます。
   Windows では、
   これらの文字に加えて <code class="literal">%</code> と <code class="literal">!</code> の前にキャレット
   (<code class="literal">^</code>) が付加されます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.escapeshellcmd-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">command</code></dt>
     <dd>
      <p class="para">
       エスケープされるコマンド
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.escapeshellcmd-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   エスケープされた文字列
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.escapeshellcmd-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>escapeshellcmd()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// 意図的に、任意の数の引数を指定できるようにしています<br /></span><span style="color: #0000BB">$command </span><span style="color: #007700">= </span><span style="color: #DD0000">'./configure '</span><span style="color: #007700">.</span><span style="color: #0000BB">$_POST</span><span style="color: #007700">[</span><span style="color: #DD0000">'configure_options'</span><span style="color: #007700">];<br /><br /></span><span style="color: #0000BB">$escaped_command </span><span style="color: #007700">= </span><span style="color: #0000BB">escapeshellcmd</span><span style="color: #007700">(</span><span style="color: #0000BB">$command</span><span style="color: #007700">);<br /> <br /></span><span style="color: #0000BB">system</span><span style="color: #007700">(</span><span style="color: #0000BB">$escaped_command</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.escapeshellcmd-notes">
  <h3 class="title">注意</h3>
   <div class="warning"><strong class="warning">警告</strong>
    <p class="para">
     <span class="function"><strong>escapeshellcmd()</strong></span>
     はコマンド文字列全体に適用しなければなりません。
     また、そうしたところで、まだ任意の数の引数を渡すことによる攻撃を許してしまいます。
     単一の引数をエスケープするには、かわりに <span class="function"><a href="function.escapeshellarg.php" class="function">escapeshellarg()</a></span>
     を使わねばなりません。
    </p>
   </div>
   <div class="warning"><strong class="warning">警告</strong>
    <p class="para">
     スペースは
     <span class="function"><strong>escapeshellcmd()</strong></span>
     関数ではエスケープされません。
     たとえば、Windows で問題になりがちな
     <code class="literal">C:\Program Files\ProgramName\program.exe</code>
     のようなパスが当てはまります。
     この問題は以下のようなコードで緩和できます:
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$cmd </span><span style="color: #007700">= </span><span style="color: #0000BB">preg_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">'`(?&lt;!^) `'</span><span style="color: #007700">, </span><span style="color: #DD0000">'^ '</span><span style="color: #007700">, </span><span style="color: #0000BB">escapeshellcmd</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">));</span></span></code></div>
    </div>

    </p>
   </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.escapeshellcmd-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.escapeshellarg.php" class="function" rel="rdfs-seeAlso">escapeshellarg()</a> - シェル引数として使用される文字列をエスケープする</span></li>
    <li><span class="function"><a href="function.exec.php" class="function" rel="rdfs-seeAlso">exec()</a> - 外部プログラムを実行する</span></li>
    <li><span class="function"><a href="function.popen.php" class="function" rel="rdfs-seeAlso">popen()</a> - プロセスへのファイルポインタをオープンする</span></li>
    <li><span class="function"><a href="function.system.php" class="function" rel="rdfs-seeAlso">system()</a> - 外部プログラムを実行し、出力を表示する</span></li>
    <li><a href="language.operators.execution.php" class="link">バッククォート演算子</a></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>