draft/man7/packet.7

   1 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
   4 .\" Permission is granted to distribute possibly modified copies
   5 .\" of this page provided the header is included verbatim,
   6 .\" and in case of nontrivial modification author and date
   7 .\" of the modification is added to the header.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" $Id: packet.7,v 1.13 2000/08/14 08:03:45 ak Exp $
  11 .\"
  12 .\"*******************************************************************
  13 .\"
  14 .\" This file was generated with po4a. Translate the source file.
  15 .\"
  16 .\"*******************************************************************
  17 .TH PACKET 7 2012\-05\-10 Linux "Linux Programmer's Manual"
  18 .SH 名前
  19 packet \- デバイスレベルのパケットインターフェース
  20 .SH 書式
  21 .nf
  22 \fB#include <sys/socket.h>\fP
  23 .br
  24 \fB#include <netpacket/packet.h>\fP
  25 .br
  26 \fB#include <net/ethernet.h> /* the L2 protocols */\fP
  27 .sp
  28 \fBpacket_socket = socket(AF_PACKET, int \fP\fIsocket_type\fP\fB, int \fP\fIprotocol\fP\fB);\fP
  29 .fi
  30 .SH 説明
  31 packet ソケットは、デバイスドライバ (OSI レイヤ 2) レベルで 生のパケット (raw packet) を送受信するために用いられる。
  32 packet ソケットを使うと、ユーザー空間で物理層の上に プロトコルモジュールを実装することができる。
  33
  34 \fIsocket_type\fP には \fBSOCK_RAW\fP と \fBSOCK_DGRAM\fP のいずれかを指定する。 \fBSOCK_RAW\fP
  35 はリンクレベルヘッダを含む raw パケットを、 \fBSOCK_DGRAM\fP はリンクレベルヘッダが削除された加工済みパケットを示す。
  36 リンクレベルヘッダ情報は \fIsockaddr_ll\fP で共通のフォーマットで入手できる。 \fIprotocol\fP には IEEE 802.3
  37 プロトコル番号を ネットワークバイトオーダーで指定する。 指定できるプロトコルのリストは、インクルードファイル
  38 \fI<linux/if_ether.h>\fP を参照。プロトコルを \fBhtons(ETH_P_ALL)\fP
  39 にすると、全てのプロトコルが受信される。 外部から来たパケットのうち指定したプロトコルのものは、
  40 カーネルに実装されているプロトコルに渡される前の段階で、 packet ソケットに渡される。
  41
  42 packet ソケットをオープンできるのは、 実効ユーザーID が 0 のプロセスか、 \fBCAP_NET_RAW\fP
  43 ケーパビリティを持つプロセスだけである。
  44
  45 \fBSOCK_RAW\fP パケットでは、パケットをデバイスドライバと受け渡しする際、 パケットデータに変更が行われることはない。
  46 パケットの受信時には、アドレスの解析だけは行われ、 標準的な \fIsockaddr_ll\fP
  47 アドレス構造体に渡される。パケットの送信時には、ユーザが指定する バッファに物理層のヘッダが含まれている必要がある。
  48 パケットはそのまま修正を受けずに、行き先アドレスから決定される インターフェースのネットワークドライバにキューイングされる。
  49 デバイスドライバによっては、他のヘッダを常に追加するものもある。 \fBSOCK_RAW\fP は Linux 2.0 の obosolete な
  50 \fBAF_INET/SOCK_PACKET\fP と似ているが、互換性があるわけではない。
  51
  52 \fBSOCK_DGRAM\fP はやや高位のレベルで動作する。物理ヘッダは、パケットがユーザーに 渡される前に削除される。 \fBSOCK_DGRAM\fP の
  53 packet ソケットを通して送られるパケットは、 \fIsockaddr_ll\fP の行き先アドレスの情報に基づき、適切な物理層のヘッダが付加されてから、
  54 キューに送られる。
  55
  56 デフォルトでは、指定したプロトコル型のパケットはすべて packet ソケットに送られる。特定のインターフェースからのパケットだけを
  57 取得したい場合には、 \fIstruct sockaddr_ll\fP にアドレスを指定して \fBbind\fP(2)  を呼び、 packet
  58 ソケットをそのインターフェースに結び付ける (バインドする)。 バインドの際には、アドレスフィールドのうち \fIsll_protocol\fP と
  59 \fIsll_ifindex\fP だけが用いられる。
  60
  61 \fBconnect\fP(2)  操作は packet ソケットではサポートされていない。
  62
  63 \fBMSG_TRUNC\fP フラグが \fBrecvmsg\fP(2), \fBrecv\fP(2), \fBrecvfrom\fP(2)  に渡されると、
  64 (バッファサイズより大きかったとしても) 常に実際に通信された パケットの長さが返される。
  65 .SS アドレスのタイプ
  66 sockaddr_ll はデバイスに依存しない物理層のアドレスである。
  67
  68 .in +4n
  69 .nf
  70 struct sockaddr_ll {
  71     unsigned short sll_family;   /* 常に AF_PACKET */
  72     unsigned short sll_protocol; /* 物理層のプロトコル */
  73     int            sll_ifindex;  /* インターフェース番号 */
  74     unsigned short sll_hatype;   /* ARP ハードウェア種別 */
  75     unsigned char  sll_pkttype;  /* パケット種別 */
  76     unsigned char  sll_halen;    /* アドレスの長さ */
  77     unsigned char  sll_addr[8];  /* 物理層のアドレス */
  78 };
  79 .fi
  80 .in
  81
  82 \fIsll_protocol\fP は標準的なイーサネットプロトコルのタイプで、 ネットワーク
  83 バイトオーダーで記述する。 インクルードファイル
  84 \fI<linux/if_ether.h>\fP で定義されている。 これがこのソケットのプロト
  85 コルのデフォルトとなる。 \fIsll_ifindex\fP はそのインターフェースの interface
  86 index である (\fBnetdevice\fP(7) を参照)。 0 は (バインドが許可されている) 任
  87 意のインターフェースにマッチする。 \fIsll_hatype\fP は、インクルードファイル
  88 \fI<linux/if_arp.h>\fP で定義されている ARP 種別である。
  89 \fIsll_pkttype\fP はパケット種別である。指定できる種別は以下のいずれかである:
  90 \fBPACKET_HOST\fP (ローカルホスト向けのパケット)、 \fBPACKET_BORADCAST\fP (物理層
  91 のブロードキャストパケット)、 \fBPACKET_MULTICAST\fP (物理層のマルチキャストア
  92 ドレスに送るパケット)、 \fBPACKET_OTHERHOST\fP (他のホストに向けられたパケット
  93 のうち、 無差別モード (promiscuous mode: 後述) のデバイスドライバにより補足
  94 されたもの)、 \fBPACKET_OUTGOING\fP (ローカルホストから発信され、 packet ソケッ
  95 トにループバックしてきたパケット)。 これらの種別が意味を持つのは受信時のみ
  96 である。 \fIsll_addr\fP と \fIsll_halen\fP は、物理層の (つまり IEEE 802.3 の)
  97 アドレスとその長さである。 厳密な解釈はデバイスに依存する。
  98
  99 パケットを送る場合は、 \fIsll_family\fP, \fIsll_addr\fP, \fIsll_halen\fP, \fIsll_ifindex\fP
 100 を指定すれば十分である。 その他のフィールドは 0 にしておくべきである。 \fIsll_hatype\fP と \fIsll_pkttype\fP
 101 には受信したパケットの情報が設定される。 バインドの際には、 \fIsll_protocol\fP と \fIsll_ifindex\fP だけが使用される。
 102 .SS ソケットオプション
 103 packet ソケットは、物理層のマルチキャストや 無差別モード (promiscuous mode) を設定して使うことができる。 これには
 104 \fBSOL_PACKET\fP と以下のオプションのいずれかを指定して \fBsetsockopt\fP(2)  を呼べばよい。 バインドを追加する場合は
 105 \fBPACKET_ADD_MEMBERSHIP\fP であり、取り去る場合は \fBPACKET_DROP_MEMBERSHIP\fP である。これらはいずれも
 106 \fBpacket_mreq\fP 構造体を引き数に取る。
 107
 108 .in +4n
 109 .nf
 110 struct packet_mreq {
 111     int            mr_ifindex;    /* インターフェース番号 */
 112     unsigned short mr_type;       /* 動作 */
 113     unsigned short mr_alen;       /* アドレスの長さ */
 114     unsigned char  mr_address[8]; /* 物理層のアドレス */
 115 };
 116 .fi
 117 .in
 118
 119 \fImr_ifindex\fP は、ステータスを変更したいインターフェースの インターフェース番号である。 \fImr_type\fP
 120 パラメータは実行する動作を指定する: \fBPACKET_MR_PROMISC\fP は、共有している媒体からの全てのパケットを受信できるようにする
 121 (しばしば "無差別モード (promiscuous mode)" と呼ばれる)。 \fBPACKET_MR_MULTICAST\fP は、そのソケットを、
 122 \fImr_address\fP と \fImr_alen\fP で指定される物理層のマルチキャストブループにバインドする。
 123 \fBPACKET_MR_ALLMULTI\fP は socket を up にして、そのインターフェースに到達したすべての
 124 マルチキャストパケットを受信できるようにする。
 125
 126 昔からある ioctl だけでなく、 \fBSIOCSIFFLAGS\fP, \fBSIOCADDMULTI\fP, \fBSIOCDELMULTI\fP
 127 を同じ目的に用いることができる。
 128 .SS ioctl
 129 .\" FIXME Document SIOCGSTAMPNS
 130 \fBSIOCGSTAMP\fP を用いると、最後に受信したパケットのタイムスタンプを得ることができる。 引き数は \fIstruct timeval\fP
 131 である。
 132
 133 さらに、 \fBnetdevice\fP(7)  および \fBsocket\fP(7)  で定義されている標準の ioctl はいずれも packet
 134 ソケットに指定可能である。
 135 .SS エラー処理
 136 packet ソケットは、パケットをデバイスドライバに渡すときに 起きたエラーしか処理しない。遅延エラー (pending error)
 137 に関する概念は持っていない。
 138 .SH エラー
 139 .TP
 140 \fBEADDRNOTAVAIL\fP
 141 不明なマルチキャストグループアドレスが渡された。
 142 .TP
 143 \fBEFAULT\fP
 144 ユーザが渡したメモリアドレスが不正。
 145 .TP
 146 \fBEINVAL\fP
 147 引き数が不正。
 148 .TP
 149 \fBEMSGSIZE\fP
 150 パケットがインターフェースの MTU より大きい。
 151 .TP
 152 \fBENETDOWN\fP
 153 インターフェースが up でない。
 154 .TP
 155 \fBENOBUFS\fP
 156 パケットに割り当てるメモリが足りない。
 157 .TP
 158 \fBENODEV\fP
 159 デバイス名が不明。あるいはインターフェースアドレスで指定された インターフェースインデックスが不明。
 160 .TP
 161 \fBENOENT\fP
 162 パケットを一つも受信していない。
 163 .TP
 164 \fBENOTCONN\fP
 165 インターフェースアドレスが渡されなかった。
 166 .TP
 167 \fBENXIO\fP
 168 インターフェースアドレスに不正なインターフェースインデックスが含まれている。
 169 .TP
 170 \fBEPERM\fP
 171 この操作を行うのに必要な権限をユーザが持っていない。
 172
 173 上記以外のエラーが、低レベルのドライバで生成されることがある。
 174 .SH バージョン
 175 \fBAF_PACKET\fP は Linux 2.2 の新機能である。これより古いバージョンの Linux では \fBSOCK_PACKET\fP
 176 のみをサポートしていた。
 177 .PP
 178 インクルードファイル \fI<netpacket/packet.h>\fP が存在するのは glibc 2.1 以降である。
 179 それ以前のシステムでは以下のようにする必要がある:
 180 .sp
 181 .in +4n
 182 .nf
 183 #include <asm/types.h>
 184 #include <linux/if_packet.h>
 185 #include <linux/if_ether.h>  /* The L2 protocols */
 186 .fi
 187 .in
 188 .SH 注意
 189 移植性の必要なプログラムでは、 \fBpcap\fP(3)  経由で \fBAF_PACKET\fP を用いることをお薦めする。ただし、この方法では
 190 \fBAF_PACKET\fP の機能すべてを利用することはできない。
 191
 192 \fBSOCK_DGRAM\fP packet ソケットは、IEEE 802.3 フレームの IEEE 802.2 LLC ヘッダの
 193 生成や解析を行おうとしない。 \fBETH_P_802_3\fP が送信プロトコルに指定されると、カーネルは 802.3 フレームを 生成して length
 194 フィールドに書き込む。 完全に準拠したパケットを得るためにはユーザーが LLC ヘッダを 与える必要がある。到着した 802.3 パケットでは、
 195 DSAP/SSAP protocol の各フィールドは多重化 (multiplex) されていない。 代わりにこれらは LLC ヘッダが前置された
 196 \fBETH_P_802_2\fP プロトコルとして与えられる。したがって、 \fBETH_P_802_3\fP にバインドすることはできない。かわりに
 197 \fBETH_P_802_2\fP にバインドし、自分自身でプロトコルの多重化を行うこと。 送信のデフォルトは、プロトコルフィールドを持つ 標準の
 198 Ethernet DIX encapsulation である。
 199
 200 packet ソケットは入出力の firewall chain に影響をうけない。
 201 .SS 移植性
 202 Linux 2.0 では、 packet ソケットを得る方法は \fBsocket(AF_INET, SOCK_PACKET,
 203 \fP\fIprotocol\fP\fB)\fP を呼ぶやり方しかなかった。この方法はまだサポートされているが、 用いないことを強く推奨する。現在の方法との主な違いは、
 204 \fBSOCK_PACKET\fP ではインターフェースの指定に古い \fIstruct sockaddr_pkt\fP
 205 を用いる点である。これには物理層からの独立性がない。
 206
 207 .in +4n
 208 .nf
 209 struct sockaddr_pkt {
 210     unsigned short spkt_family;
 211     unsigned char  spkt_device[14];
 212     unsigned short spkt_protocol;
 213 };
 214 .fi
 215 .in
 216
 217 \fIspkt_family\fP はデバイスのタイプ、 \fIspkt_protocol\fP は \fI<sys/if_ether.h>\fP
 218 で定義されている IEEE 802.3 プロトコルタイプ、 \fIspkt_device\fP はデバイスの名前を NULL 終端された文字列で与えたもの
 219 (例: eth0) である。
 220
 221 この構造体は obsolete であり、 新しくコードを書く時には用いるべきでない。
 222 .SH バグ
 223 glibc 2.1 には \fBSOL_PACKET\fP の定義がない。回避策としては、以下のようにするとよい。
 224 .in +4n
 225 .nf
 226
 227 #ifndef SOL_PACKET
 228 #define SOL_PACKET 263
 229 #endif
 230
 231 .fi
 232 .in
 233 この問題は新しいバージョンの glibc では修正されている。 libc5 のシステムにはこの問題はない。
 234
 235 IEEE 802.2/803.3 の LLC の扱い方は、バグと考えても良いだろう。
 236
 237 ソケットフィルターについて記載されていない。
 238
 239 .\" .SH CREDITS
 240 .\" This man page was written by Andi Kleen with help from Matthew Wilcox.
 241 .\" AF_PACKET in Linux 2.2 was implemented
 242 .\" by Alexey Kuznetsov, based on code by Alan Cox and others.
 243 \fBMSG_TRUNC\fP \fBrecvmsg\fP(2)  拡張は非常にまずい対処であり、制御メッセージで置き換えるべきである。 今のところ
 244 \fBSOCK_DGRAM\fP 経由でパケットについていた宛先アドレスを得る方法がない。
 245 .SH 関連項目
 246 \fBsocket\fP(2), \fBpcap\fP(3), \fBcapabilities\fP(7), \fBip\fP(7), \fBraw\fP(7),
 247 \fBsocket\fP(7)
 248
 249 標準 IP Ethernet encapsulation に関しては RFC\ 894 を、 IEEE 802.3 IP encapsulation
 250 に関しては RFC\ 1700 を参照。
 251
 252 物理層のプロトコルに関する記述は \fI<linux/if_ether.h>\fP インクルードファイルにある。
 253 .SH この文書について
 254 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 255 である。プロジェクトの説明とバグ報告に関する情報は
 256 http://www.kernel.org/doc/man\-pages/ に書かれている。