| Heimdal Kerberos 5 credential cache functions(3) | HeimdalKerberos5library | Heimdal Kerberos 5 credential cache functions(3) |
名称
Heimdal Kerberos 5 資格証明キャッシュ関数-関数
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_register (krb5_context context, const krb5_cc_ops *ops, krb5_boolean override)
変数
KRB5_LIB_VARIABLE const krb5_cc_ops krb5_acc_ops
詳細説明
関数説明
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_cache_end_seq_get (krb5_context context, krb5_cc_cache_cursor cursor)
カーソル `cursor' を破壊します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_cache_get_first (krb5_context context, const char * type, krb5_cc_cache_cursor * cursor)
指定されたタイプのすべてのキャッシュで繰り返しを始めます。また、 krb5_cccol_cursor_new() を参照してください。パラメータ:
context Kerberos 5 コンテキスト。
type 繰り返すオプションのタイプ、NULL であるなら、デフォルトのキャッシュが使用されます。
cursor カーソルは、
krb5_cc_cache_end_seq_get() で解放されるべきです。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_cache_match (krb5_context context, krb5_principal client, krb5_ccache * id)
デフォルトのプリンシパルとして `principal' がある一致する資格証明キャッシュを検索します。成功すれば、`id' は、 krb5_cc_close() または krb5_cc_destroy() でを解放する必要があります。パラメータ:
context Kerberos 5 コンテキスト。
client 検索するプリンシパル。
id 返される資格証明キャッシュ。
返り値:
失敗すれば、エラーコードが返され、`id' は、NULL に設定されます。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_cache_next (krb5_context context, krb5_cc_cache_cursor cursor, krb5_ccache * id)
`id' の (`cursor') によって指された次のキャッシュを検索し、`cursor' を進めます。パラメータ:
context Kerberos 5 コンテキスト。
cursor
krb5_cc_cache_get_first() によって返されるイテレータ (iterator) のカーソル。
id 次のキャッシュ。
返り値:
0 またはエラーコードを返します。キャッシュの終りに到達するとき、KRB5_CC_END を返します、 krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_cc_clear_mcred (krb5_creds * mcred)
`mcreds' をクリアするので、krb5_cc_retrieve_cred でそれを使用することができます。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_close (krb5_context context, krb5_ccache id)
キャッシュ `id' を使用することを停止して、関連するリソースを解放します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_copy_cache (krb5_context context, const krb5_ccache from, krb5_ccache to)
ちょうど krb5_cc_copy_match_f() に似ていますが、すべてをコピーします。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_copy_creds (krb5_context context, const krb5_ccache from, krb5_ccache to)
MIT 互換のグルー (glue)。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_copy_match_f (krb5_context context, const krb5_ccache from, krb5_ccache to, krb5_boolean(*)(krb5_context, void *, const krb5_creds *) match, void * matchctx, unsigned int * matched)
与えられた比較関数が true を返すなら、`from' の内容を `to' にコピーします。パラメータ:
context Kerberos 5 コンテキスト。
from データのコピー元のキャッシュ。
to データのコピー先のキャッシュ。
match cred 引数がコピーされるべきであるなら、TRUE を返すべき比較関数、 NULL であるなら、すべての資格証明がコピーされます。
matchctx 比較関数の渡されるコンテキスト。
matched 一致した資格証明があったなら、true に設定します、 NULL であるかもしれません。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_default (krb5_context context, krb5_ccache * id)
`id' のデフォルトのキャッシュをオープンします。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_cc_default_name (krb5_context context)
デフォルトのキャッシュを含んでいる静的な文字列のコンテキストへのポインタを返します。返り値:
デフォルトの資格証明キャッシュへの文字列。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_destroy (krb5_context context, krb5_ccache id)
キャッシュ `id' を削除します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_end_seq_get (krb5_context context, const krb5_ccache id, krb5_cc_cursor * cursor)
カーソル `cursor' を破壊します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_gen_new (krb5_context context, const krb5_cc_ops * ops, krb5_ccache * id)
`id' のタイプ `ops' の新しいキャッシュを生成します。廃止予定: 代わりに krb5_cc_new_unique() を使用します。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_config (krb5_context context, krb5_ccache id, krb5_const_principal principal, const char * name, krb5_data * data)
キャッシュ中の資格証明キャッシュのためのいくつかの設定を取得します。パラメータ:
context Kerberos コンテキスト。
id データを格納する資格証明キャッシュ。
principal 特有のプリンシパルのための設定、NULL であるなら、すべてのキャッシュのためにグローバル。
name 設定が格納される名前。
data 取って来たデータ、
krb5_data_free() で解放します。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_flags (krb5_context context, krb5_ccache id, krb5_flags * flags)
`id' のフラグを取得し、`flags' にそれらを格納します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_friendly_name (krb5_context context, krb5_ccache id, char ** name)
資格証明キャッシュでフレンドリ (friendly) な名前を返します。 krb5_xfree() で結果を解放します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_full_name (krb5_context context, krb5_ccache id, char ** str)
完全な解決可能な名前のキャッシュを返します。パラメータ:
context Kerberos コンテキスト。
id 見つかった資格証明キャッシュへのポインタを返します。
str 返された資格証明キャッシュの名前、krb5_xfree() で解放します。
返り値:
0 またはエラーを返し、(次に、*str は、NULL に設定されます)。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_kdc_offset (krb5_context context, krb5_ccache id, krb5_deltat * offset)
クライアントと KDC の間の時間のオフセットを取得します。バックエンドが KDC オフセットをサポートしないなら、グローバルに設定されたコンテキストを使用します。
パラメータ:
context Kerberos 5 コンテキスト。
id 資格証明キャッシュ。
offset 秒単位のオフセット。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_lifetime (krb5_context context, krb5_ccache id, time_t * t)
キャッシュの初期チケットの生存期間を取得します。キャッシュの初期チケットの生存期間を取得し、初期チケットが見つからなかったなら、エラーコード KRB5_CC_END が返されます。
パラメータ:
context Kerberos 5 コンテキスト。
id 資格証明キャッシュ。
t 初期チケットの相対的な生存期間。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_cc_get_name (krb5_context context, krb5_ccache id)
キャッシュ `id' の名前を返します。KRB5_LIB_FUNCTION const krb5_cc_ops* KRB5_LIB_CALL krb5_cc_get_ops (krb5_context context, krb5_ccache id)
キャッシュ `id' の krb5_cc_ops を返します。KRB5_LIB_FUNCTION const krb5_cc_ops* KRB5_LIB_CALL krb5_cc_get_prefix_ops (krb5_context context, const char * prefix)
接頭辞を扱うために `context' に登録される cc ops を取得します。接頭辞は、完全な資格証明キャッシュ名または接頭辞を指定でき、関数は、それがあるなら、最初のコロン (:) までの部分のみを使用します。接頭辞の引数が NULL であるなら、デフォルトのキャッシュの実装がが返されます。返り値:
ops が見つからないなら、NULL を返します。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_principal (krb5_context context, krb5_ccache id, krb5_principal * principal)
`principal' の `id' のプリンシパルを返します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_cc_get_type (krb5_context context, krb5_ccache id)
キャッシュ `id' のタイプを返します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_get_version (krb5_context context, const krb5_ccache id)
`id' のバージョンを返します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_initialize (krb5_context context, krb5_ccache id, krb5_principal primary_principal)
`primary_principal' のための `id' に新しいキャッシュを作成します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_last_change_time (krb5_context context, krb5_ccache id, krb5_timestamp * mtime)
資格証明キャッシュが修正された最後の時間を返します。パラメータ:
context Kerberos 5 コンテキスト。
id プローブする資格証明キャッシュ。
mtime 最後の更新時刻、エラーで 0 に設定。
返り値:
0 またはエラーを返す。 krb5_get_error_message() を参照してください。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_move (krb5_context context, krb5_ccache from, krb5_ccache to)
1 つの資格証明キャッシュから別のものに内容を移動します。操作は、不可分のスイッチです。パラメータ:
context Kerberos コンテキスト。
from 内容を移動する元の資格証明キャッシュ。
to 内容を移動する先の資格証明キャッシュ。
返り値:
成功すれば、from は、解放されます。失敗すれば、エラーコードが返され、from と to は、両方ともまだ割り付けられたままです、krb5_get_error_message() を参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_new_unique (krb5_context context, const char * type, const char * hint, krb5_ccache * id)
`id' に `type` の新しいユニークなキャッシュを生成します。 `type' が NULL であるなら、ライブラリは、デフォルトの資格証明キャッシュタイプを選びます。供給された `hint' (NULL であるかもしれません) は、資格証明の名前に基づいて使用することができる資格証明キャッシュタイプである文字列で、これは、ユーザが資格証明を区別することをより簡単にします。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_next_cred (krb5_context context, const krb5_ccache id, krb5_cc_cursor * cursor, krb5_creds * creds)
`creds' の (`id', `cursor') によって指される次の cred を検索し、`cursor' を進めます。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_register (krb5_context context, const krb5_cc_ops * ops, krb5_boolean override)
操作 `ops' で新しいキャッシュタイプを追加し、`override' であるなら、あらゆる既存のものを上書きします。パラメータ:
context Kerberos コンテキスト。
ops プラグインシンボルのタイプ。
override 登録が同じ名前で既存の ops を上書きするなら、選択するフラグ。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_remove_cred (krb5_context context, krb5_ccache id, krb5_flags which, krb5_creds * cred)
`id' から `cred', `which' によって識別される資格証明を削除します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_resolve (krb5_context context, const char * name, krb5_ccache * id)
`residual' の仕様からの `id' のキャッシュをを見つけて割り付けます。キャッシュ名がコロンを含んでいないなら、ファイル名としてそれを解釈します。パラメータ:
context Kerberos コンテキスト。
name 資格証明キャッシュの文字列の名前。
id 見つかった資格証明キャッシュへのポインタを返します。
返り値:
0 またはエラーコードを返します。エラーの場合に、id は、NULL に設定されます、krb5_get_error_message() を参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_retrieve_cred (krb5_context context, krb5_ccache id, krb5_flags whichfields, const krb5_creds * mcreds, krb5_creds * creds)
`creds' の `id' から `mcreds' (と `whichfields') によって識別される資格証明を検索します。 'creds' は、krb5_free_cred_contents を使用して呼び出し側によって解放されなければなりません。パラメータ:
context Kerberos 5 コンテキスト。
id Kerberos 5 資格証明キャッシュ。
whichfields
krb5_compare_creds() の whichfields と同じフラグである、一致する資格証明のために使用するフィールド。
mcreds 比較のために使用するテンプレートの資格証明。
creds 返される資格証明、
krb5_free_cred_contents() で解放します。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_set_config (krb5_context context, krb5_ccache id, krb5_const_principal principal, const char * name, krb5_data * data)
キャッシュの資格証明キャッシュのためのいくつかの設定を格納します。同じ名前の下の既存の設定は、上書きされます。パラメータ:
context Kerberos コンテキスト。
id データを格納する資格証明キャッシュ。
principal 特有のプリンシパルのための設定、NULL であるなら、すべてのキャッシュのためにグローバル。
name 設定が格納される名前。
data 格納するデータ、NULL であるなら、設定は、削除されます。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_set_default_name (krb5_context context, const char * name)
`context' のためのデフォルトの cc 名を `name' に設定します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_set_flags (krb5_context context, krb5_ccache id, krb5_flags flags)
`id' のフラグを `flags' を設定します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_set_friendly_name (krb5_context context, krb5_ccache id, const char * name)
資格証明キャッシュでフレンドリ (friendly) 名を設定します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_set_kdc_offset (krb5_context context, krb5_ccache id, krb5_deltat offset)
クライアントと KDC の間の時間オフセットを設定します。バックエンドが KDC オフセットをサポートしないなら、グローバルに設定されたコンテキストを使用します。
パラメータ:
context Kerberos 5 コンテキスト。
id 資格証明キャッシュ。
offset 秒単位のオフセット。
返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_start_seq_get (krb5_context context, const krb5_ccache id, krb5_cc_cursor * cursor)
`id' で繰り返しを始め、`cursor' は、最初のものに初期化されます。呼び出し側は、 krb5_cc_end_seq_get() でカーソルを解放しなければなりません。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_store_cred (krb5_context context, krb5_ccache id, krb5_creds * creds)
キャッシュ `id' に `creds' を格納します。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_cc_support_switch (krb5_context context, const char * type)
デフォルトの資格証明キャッシュがスイッチをサポートしているなら、true を返します。KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cc_switch (krb5_context context, krb5_ccache id)
特定の credcache タイプ (と、いくつかの実装のための名前) のためのデフォルトの資格証明キャッシュを切り替えてください。返り値:
エラーコードまたは 0 を返します、krb5_get_error_message() 参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cccol_cursor_free (krb5_context context, krb5_cccol_cursor * cursor)
繰り返しを終了し、すべてのリソースを解放します、終りに到達する前に行うことができます。パラメータ:
context Kerberos 5 コンテキスト。
cursor 解放される繰り返しのカーソル。
返り値:
0 またはエラーを返す、KRB5_CC_END は、繰り返しの終りで返されます。 krb5_get_error_message() を参照してください。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cccol_cursor_new (krb5_context context, krb5_cccol_cursor * cursor)
タイプに依存しないすべての資格証明キャッシュを繰り返す、新しいキャッシュの繰り返しカーソルを取得します。パラメータ:
context Kerberos コンテキスト。
cursor
krb5_cccol_cursor_next() に渡されるカーソル、
krb5_cccol_cursor_free() で解放します。
返り値:
0 とエラーコードを返します、krb5_get_error_message() を参照。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cccol_cursor_next (krb5_context context, krb5_cccol_cursor cursor, krb5_ccache * cache)
繰り返しから次の資格証明キャッシュを取得します。パラメータ:
context Kerberos 5 コンテキスト。
cursor 繰り返しカーソル。
cache 返されるカーソル、ポインタは、失敗すると NULL に設定され、成功すれば、キャッシュに設定されます。
krb5_cc_close() で解放されるか、または
krb5_cc_destroy() で破壊される必要がありる返されるキャッシュ。 MIT Kerberos は、わずかに異なった振る舞い、すべてのキャッシュが繰り返されるとき、キャッシュは、NULL に設定され、0 を返します。
返り値:
0 またはエラーを返す、KRB5_CC_END は、繰り返しの終りで返されます。 krb5_get_error_message() を参照してください。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cccol_last_change_time (krb5_context context, const char * type, krb5_timestamp * mtime)
キャッシュの収集のために最後の更新時刻を返します。問い合わせは、特定のキャッシュタイプに制限することができます。関数が 0 を返し、mtime が 0 であるなら、キャッシュの資格証明はありませんでした。パラメータ:
context Kerberos 5 コンテキスト。
type プローブする資格証明キャッシュ、NULL であるなら、すべてのタイプが、横断されます。
mtime 最後の更新時刻、エラーで 0 に設定。
返り値:
0 またはエラーを返す。 krb5_get_error_message() を参照してください。
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_validated_creds (krb5_context context, krb5_creds * creds, krb5_principal client, krb5_ccache ccache, char * service)
新しく取って来る資格証明を有効にします、krb5_verify_init_creds() も参照。パラメータ:
context Kerberos 5 コンテキスト。
creds 検証する資格証明。
client マッチするするクライアント名。
ccache 使用する資格証明キャッシュ。
service 使用するサービス名、検証するために使用するホスト名を構築するために
krb5_sname_to_principal() で使用されます。
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_is_config_principal (krb5_context context, krb5_const_principal principal)
プリンシパルが設定されたプリンシパル ( krb5_cc_set_config() の生成された部分) であるなら、 TRUE (0 でない) を返します。設定されたプリンシパルでないなら、FALSE (0) を返します。パラメータ:
context Kerberos コンテキスト。
principal 設定されたプリンシパルであるかチェックするプリンシパル。
変数説明
KRB5_LIB_VARIABLE const krb5_cc_ops krb5_acc_ops
初期値:
{
KRB5_CC_OPS_VERSION,
'API',
acc_get_name,
acc_resolve,
acc_gen_new,
acc_initialize,
acc_destroy,
acc_close,
acc_store_cred,
NULL,
acc_get_principal,
acc_get_first,
acc_get_next,
acc_end_get,
acc_remove_cred,
acc_set_flags,
acc_get_version,
acc_get_cache_first,
acc_get_cache_next,
acc_end_cache_get,
acc_move,
acc_get_default_name,
acc_set_default,
acc_lastchange,
NULL,
NULL,
}
資格証明キャッシュの実装に基づく API を含んでいる変数。
KRB5_LIB_VARIABLE const krb5_cc_ops krb5_fcc_ops
初期値:
{
KRB5_CC_OPS_VERSION,
'FILE',
fcc_get_name,
fcc_resolve,
fcc_gen_new,
fcc_initialize,
fcc_destroy,
fcc_close,
fcc_store_cred,
NULL,
fcc_get_principal,
fcc_get_first,
fcc_get_next,
fcc_end_get,
fcc_remove_cred,
fcc_set_flags,
fcc_get_version,
fcc_get_cache_first,
fcc_get_cache_next,
fcc_end_cache_get,
fcc_move,
fcc_get_default_name,
NULL,
fcc_lastchange,
fcc_set_kdc_offset,
fcc_get_kdc_offset
}
資格証明キャッシュの実装に基づく FILE を含んでいる変数。
KRB5_LIB_VARIABLE const krb5_cc_ops krb5_mcc_ops
初期値:
{
KRB5_CC_OPS_VERSION,
'MEMORY',
mcc_get_name,
mcc_resolve,
mcc_gen_new,
mcc_initialize,
mcc_destroy,
mcc_close,
mcc_store_cred,
NULL,
mcc_get_principal,
mcc_get_first,
mcc_get_next,
mcc_end_get,
mcc_remove_cred,
mcc_set_flags,
NULL,
mcc_get_cache_first,
mcc_get_cache_next,
mcc_end_cache_get,
mcc_move,
mcc_default_name,
NULL,
mcc_lastchange,
mcc_set_kdc_offset,
mcc_get_kdc_offset
}
資格証明キャッシュの実装に基づく MEMORY を含んでいる変数。
| 11 Jan 2012 | Version 1.5.2 |