3. Conventions Used in This Document (本文書で使用される表記規則)
SSHプロトコルに関連するすべての文書は、要件を記述するために、「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」、および「OPTIONAL」というキーワードを使用しなければなりません (SHALL)。これらのキーワードは、[RFC2119] に記載されているとおりに解釈されます。
| 英語 | 日本語 | 意味 |
|---|---|---|
| MUST | しなければならない / 必須である | 絶対要求事項 |
| MUST NOT | してはならない / 禁止される | 絶対禁止事項 |
| REQUIRED | 必須である | 絶対要求事項 |
| SHALL | しなければならない | 義務的要求事項 |
| SHALL NOT | してはならない | 義務的禁止事項 |
| SHOULD | すべきである / 推奨される | 強い推奨事項 |
| SHOULD NOT | すべきでない | 強い非推奨事項 |
| RECOMMENDED | 推奨される | 推奨される慣行 |
| MAY | してもよい / 可能である | 任意事項 |
| OPTIONAL | 任意である | 任意事項 |
名前空間の割り当てを記述するために使用される「PRIVATE USE」、「HIERARCHICAL ALLOCATION」、「FIRST COME FIRST SERVED」、「EXPERT REVIEW」、「SPECIFICATION REQUIRED」、「IESG APPROVAL」、「IETF CONSENSUS」、および「STANDARDS ACTION」というキーワードは、[RFC2434] に記載されているとおりに解釈されます。
プロトコルフィールド (Protocol Field) とそれを埋めるための可能な値は、この一連の文書で定義されています。プロトコルフィールドは、メッセージ定義で定義されます。例として、SSH_MSG_CHANNEL_DATAは以下のように定義されています。
byte SSH_MSG_CHANNEL_DATA
uint32 recipient channel
string data
これらの文書全体を通じて、フィールドを参照する場合は、シングルクォート (単一引用符) 内に表示されます。これらのフィールドを埋めるための値を参照する場合は、ダブルクォート (二重引用符) 内に表示されます。上記の例を使用すると、'data' の可能な値は "foo" と "bar" です。