release/man2/capget.2

   1 .\" written by Andrew Morgan <morgan@kernel.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" may be distributed as per GPL
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Modified by David A. Wheeler <dwheeler@ida.org>
   8 .\" Modified 2004-05-27, mtk
   9 .\" Modified 2004-06-21, aeb
  10 .\" Modified 2008-04-28, morgan of kernel.org
  11 .\"     Update in line with addition of file capabilities and
  12 .\"     64-bit capability sets in kernel 2.6.2[45].
  13 .\" Modified 2009-01-26, andi kleen
  14 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" This file was generated with po4a. Translate the source file.
  18 .\"
  19 .\"*******************************************************************
  20 .\"
  21 .\" Japanese Version Copyright (c) 1999 HANATAKA Shinya
  22 .\"         all rights reserved.
  23 .\" Translated 1999-12-26, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  24 .\" Updated & Modified 2005-02-03, Yuichi SATO <ysato444@yahoo.co.jp>
  25 .\" Updated & Modified 2006-01-31, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  26 .\" Updated & Modified 2006-07-23, Akihiro MOTOKI, LDP v2.36
  27 .\" Updated & Modified 2008-08-11, Akihiro MOTOKI, LDP v3.05
  28 .\" Updated 2009-02-24, Akihiro MOTOKI, LDP v3.19
  29 .\"
  30 .TH CAPGET 2 2013\-03\-11 Linux "Linux Programmer's Manual"
  31 .SH 名前
  32 capget, capset \- スレッドのケーパビリティを設定/取得する
  33 .SH 書式
  34 \fB#include <sys/capability.h>\fP
  35 .sp
  36 \fBint capget(cap_user_header_t \fP\fIhdrp\fP\fB, cap_user_data_t \fP\fIdatap\fP\fB);\fP
  37 .sp
  38 \fBint capset(cap_user_header_t \fP\fIhdrp\fP\fB, const cap_user_data_t
  39 \fP\fIdatap\fP\fB);\fP
  40 .SH 説明
  41 Linux 2.2 で、スーパーユーザー (root) の権限は、個別のケーパビリティ (capabilities)
  42 へと分割され、その集合として表現されるようになった。 各スレッドは「実効ケーパビリティ (effective capability) の集合」を持ち、
  43 それによって現在どの操作が実行可能かを識別できる。 また、各スレッドは、 「継承可能ケーパビリティ (inheritable capability)
  44 の集合」と 「許可ケーパビリティ (permitted capability) の集合」を持つ。 「継承可能ケーパビリティの集合」は
  45 \fBexecve\fP(2)  を通じて渡すことができるケーパビリティの集合であり、 「許可ケーパビリティ (permitted capability)
  46 の集合」は 実効ケーパビリティや継承可能ケーパビリティとして有効にできる ケーパビリティを規定するものである。
  47 .PP
  48 この二つのシステムコールはスレッドのケーパビリティを取得したり設定したりするための 生のカーネルインターフェースである。 これらのシステムコールは
  49 Linux 特有であるというだけでなく、 カーネル API は変更されるかもしれず、これらのシステムコールの使用法 (特に
  50 \fIcap_user_*_t\fP 型という書式) はカーネルのリビジョン毎に拡張されるかもしれないが、 以前のプログラムはそのまま動作する。
  51 .sp
  52 移植性のあるインターフェースは \fBcap_set_proc\fP(3)  と \fBcap_get_proc\fP(3)  である。
  53 可能ならばアプリケーションはこれらの関数を使用すべきである。 アプリケーションに Linux 拡張を使用したい場合には、より簡単に
  54 使えるインターフェースである \fBcapsetp\fP(3)  と \fBcapgetp\fP(3)  を使用すべきである。
  55 .SS 現在の詳細
  56 現在のカーネルの詳細について注意を述べておく。 構造体は以下のように定義される。
  57 .sp
  58 .nf
  59 .in +4n
  60 #define _LINUX_CAPABILITY_VERSION_1  0x19980330
  61 #define _LINUX_CAPABILITY_U32S_1     1
  62
  63 #define _LINUX_CAPABILITY_VERSION_2  0x20071026
  64 #define _LINUX_CAPABILITY_U32S_2     2
  65
  66 typedef struct __user_cap_header_struct {
  67    __u32 version;
  68    int pid;
  69 } *cap_user_header_t;
  70
  71 typedef struct __user_cap_data_struct {
  72    __u32 effective;
  73    __u32 permitted;
  74    __u32 inheritable;
  75 } *cap_user_data_t;
  76 .fi
  77 .in -4n
  78 .sp
  79 フィールド \fIeffective\fP, \fIpermitted\fP, \fIinheritable\fP は、 \fBcapabilities\fP(7)
  80 で定義されるケーパビリティのビットマスクである。 \fICAP_*\fP はビット番号を表すインデックス値であり、 ビットフィールドに OR を行う前に
  81 \fICAP_*\fP の値の分だけビットシフトを行う必要がある。 typedef の方はポインターなので、 このシステムコールに渡す構造体を定義するには、
  82 \fIstruct __user_cap_header_struct\fP と \fIstruct __user_cap_data_struct\fP
  83 という名前を使用しなければならない。
  84
  85 カーネル 2.6.25 より前では、バージョン \fB_LINUX_CAPABILITY_VERSION_1\fP の 32
  86 ビットケーパビリティが推奨である。 カーネル 2.6.25 以降では、バージョン \fB_LINUX_CAPABILITY_VERSION_2\fP の 64
  87 ビットケーパビリティが推奨である。 64 ビットケーパビリティでは \fIdatap\fP[0] と \fIdatap\fP[1] が使用されるのに対し、 32
  88 ビットケーパビリティでは \fIdatap\fP[0] だけが使用される。
  89 .sp
  90 これらのシステムコールの挙動に影響があるもう一つの変更点は、 ファイルケーパビリティ (file capabilities) のカーネルによるサポート
  91 (VFS ケーパビリティのサポート) である。 VFS ケーパビリティのサポートは現在のところコンパイル時のオプションである (カーネル 2.6.24
  92 で追加された)。
  93 .sp
  94 \fBcapget\fP()  では、 \fIhdrp\->pid\fP のフィールド値にケーパビリティを知りたいプロセスのプロセス ID を
  95 指定することで、任意のプロセスのケーパビリティを調べることができる。
  96 .SS "VFS ケーパビリティがサポートされている場合"
  97 VFS ケーパビリティのサポートでは、特権実行ファイルにケーパビリティを 追加するためのファイル属性メソッドが作成された。
  98 この特権モデルの導入により、あるプロセスにより別のプロセスのケーパビリティ を非同期に設定する機能のカーネルによるサポートは廃止される。 つまり、VFS
  99 サポートでは、 \fBcapset\fP()  を呼び出す際に \fIhdrp\->pid\fP の値として許されるのは 0 と \fBgetpid\fP(2)
 100 が返す値だけとなる (どちらの値でも等価である)。
 101 .SS "VFS ケーパビリティがサポートされていない場合"
 102 カーネルが VFS ケーパビリティをサポートしていない場合、 \fIhdrp\fP の \fIpid\fP フィールドが 0 以外であれば、 \fBcapset\fP()
 103 の操作対象は \fIpid\fP で指定されたスレッドのケーパビリティになる。 \fIpid\fP が 0
 104 の場合は呼び出し元のスレッドのケーパビリティが操作対象となる。 \fIpid\fP がシングルスレッドプロセスを参照している場合、 \fIpid\fP
 105 は以前から使われているプロセスID を使って指定できる。 マルチスレッドプロセス内のあるスレッドを対象にする場合は、 \fBgettid\fP(2)
 106 が返すスレッドID を用いて指定する必要がある。 また、 \fBcapset\fP()  では \-1 や \-1 より小さな値を指定することもできる。 \-1
 107 は呼び出し元と \fBinit\fP(1)  を除く全てのスレッドを対象として変更を行うことを、 \-1 より小さな値は ID が \-\fIpid\fP
 108 のプロセスグループの全メンバ を対象として変更を行うことを意味する。
 109
 110 このデータの詳細は \fBcapabilities\fP(7)  を参照すること。
 111 .SH 返り値
 112 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
 113
 114 \fIhdrp\fP のフィールド \fIversion\fP にサポートされていない値が指定された場合、 呼び出しはエラー \fBEINVAL\fP で失敗し、
 115 \fIversion\fP にカーネル推奨の \fB_LINUX_CAPABILITY_VERSION_?\fP を設定する。
 116 このようにして、現在の推奨ケーパビリティリビジョンが何かを 調べることができる。
 117 .SH エラー
 118 .TP
 119 \fBEFAULT\fP
 120 不正なメモリーアドレス。 \fIhdrp\fP は NULL であってはならない。 \fIdatap\fP に NULL
 121 を指定してよいのは、ユーザーがカーネルがサポートしている 推奨のケーパビリティバージョンを判定しようとしているときだけである。
 122 .TP
 123 \fBEINVAL\fP
 124 引き数のどれかが無効である。
 125 .TP
 126 \fBEPERM\fP
 127 「許可ケーパビリティセット」にケーパビリティを追加しようとしているか、 もしくは「許可ケーパビリティセット」に含まれないケーパビリティを
 128 「実効ケーパビリティセット」や「継承可能ケーパビリティセット」に セットしようとしている。
 129 .TP
 130 \fBEPERM\fP
 131 呼び出し元が自分以外のスレッドのケーパビリティを \fBcapset\fP()  を使って修正しようとしたが、十分な特権がなかった。 VFS
 132 ケーパビリティをサポートしているカーネルでは、 この操作が許可されることは決してない。 VFS ケーパビリティをサポートしていないカーネルでは、
 133 \fBCAP_SETPCAP\fP ケーパビリティが必要である。 (バージョン 2.6.11 より前のカーネルには、 このケーパビリティを持たないスレッドが
 134 \fIpid\fP フィールドに 0 でない値 (つまり、0 の代わりに \fBgetpid\fP(2)  が返す値)
 135 を指定して自分自身のケーパビリティを変更しようとした場合にも、 このエラーが発生するというバグがあった。)
 136 .TP
 137 \fBESRCH\fP
 138 そのようなスレッドが存在しない。
 139 .SH 準拠
 140 これらのシステムコールは Linux 独自である。
 141 .SH 注意
 142 ケーパビリティを設定したり取得したりする機能のための移植性ある インターフェースは \fIlibcap\fP ライブラリによって提供される。
 143 このライブラリは以下から入手できる:
 144 .br
 145 .UR http://git.kernel.org/cgit\:/linux\:/kernel\:/git\:/morgan\:\:/libcap.git
 146 .UE
 147 .SH 関連項目
 148 \fBclone\fP(2), \fBgettid\fP(2), \fBcapabilities\fP(7)
 149 .SH この文書について
 150 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
 151 である。プロジェクトの説明とバグ報告に関する情報は
 152 http://www.kernel.org/doc/man\-pages/ に書かれている。