Slurm Credential Plugin Programmer Guide

Overview

This document describe.
このドキュメントでは説明します。
Slurm credential plugins and the API that defines them.
Slurm資格情報プラグインとそれらを定義するAPI。
It is intended as a resource to programmers wishing to write their own Slurm credential plugins.
これは、独自のSlurm資格情報プラグインを作成したいプログラマー向けのリソースとして意図されています。

Slurm credential plugins are Slurm plugins that implement a digital signature mechanism.
Slurm資格情報プラグインは、デジタル署名メカニズムを実装するSlurmプラグインです。
The slurmctld daemon generates a job step credential, signs it, and transmits it to an srun program.
slurmctldデーモンは、ジョブステップ資格情報を生成して署名し、srunプログラムに送信します。
The srun program then transmits it to the slurmd daemons directly.
次に、srunプログラムはそれをslurmdデーモンに直接送信します。
The slurmctld daemon does not communicate directly with the slurmd daemons at this time for performance reasons, but the job step credential must be validated by the slurmd daemon as being generated by the slurmctld daemon.
パフォーマンス上の理由から、現時点ではslurmctldデーモンはslurmdデーモンと直接通信しませんが、ジョブステップの資格情報は、slurmctldデーモンによって生成されたものとしてslurmdデーモンによって検証される必要があります。
Digital signatures provide this validation mechanism.
デジタル署名は、この検証メカニズムを提供します。
The plugins must conform to the Slurm Plugin API with the following specifications:
プラグインは、次の仕様のSlurmプラグインAPIに準拠している必要があります。

const char plugin_type[]
The major type must be "cred." The minor type can be any recognizable abbreviation for the type of credential mechanism.
メジャータイプは「cred」である必要があります。マイナータイプは、資格情報メカニズムのタイプの認識可能な省略形にすることができます。
We recommend, for example:
たとえば、次のことをお勧めします。

munge — LLNL's Munge system.

const char plugin_name[]
Some descriptive name for the plugin.
プラグインのわかりやすい名前。
There is no requirement with respect to its format.
そのフォーマットに関する要件はありません。

const uint32_t plugin_version
If specified, identifies the version of Slurm used to build this plugin and any attempt to load the plugin from a different version of Slurm will result in an error.
指定されている場合、このプラグインのビルドに使用されたSlurmのバージョンを識別し、異なるバージョンのSlurmからプラグインをロードしようとするとエラーが発生します。
If not specified, then the plugin may be loaded by Slurm commands and daemons from any version, however this may result in difficult to diagnose failures due to changes in the arguments to plugin functions or changes in other Slurm functions used by the plugin.
指定しない場合、プラグインは任意のバージョンのSlurmコマンドおよびデーモンによってロードされる可能性がありますが、プラグイン関数の引数の変更またはプラグインが使用する他のSlurm関数の変更により、障害の診断が困難になる可能性があります。

Data Objects

The implementation must maintain (though not necessarily directly export) an enumerated errno to allow Slurm to discover as practically as possible the reason for any failed API call.
実装は、列挙型errnoを維持する必要があります（必ずしも直接エクスポートする必要はありません）。これにより、SlurmはAPI呼び出しの失敗の理由を可能な限り実際に検出できるようになります。
Plugin-specific enumerated integer values may be used when appropriate.
プラグイン固有の列挙整数値は、必要に応じて使用できます。

These values must not be used as return values in integer-valued functions in the API.
これらの値は、APIの整数値関数の戻り値として使用しないでください。
The proper error return value from integer-valued functions is SLURM_ERROR.
整数値関数からの適切なエラー戻り値はSLURM_ERRORです。
The implementation should endeavor to provide useful and pertinent information by whatever means is practical.
実装は、実用的な手段で有用で適切な情報を提供するように努める必要があります。
Successful API calls are not required to reset any errno to a known value.
errnoを既知の値にリセットするために、API呼び出しが成功する必要はありません。
However, the initial value of any errno, prior to any error condition arising, should be SLURM_SUCCESS.
ただし、エラー状態が発生する前のerrnoの初期値は、SLURM_SUCCESSである必要があります。

API Functions

The following functions must appear.
次の関数が表示される必要があります。
Functions which are not implemented should be stubbed.
実装されていない関数はスタブする必要があります。

int init (void)

Description:
Called when the plugin is loaded, before any other functions are called.
プラグインがロードされたときに、他の関数が呼び出される前に呼び出されます。
Put global initialization here.
ここにグローバル初期化を配置します。

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

void fini (void)

Description:
Called when the plugin is removed.
プラグインが削除されたときに呼び出されます。
Clear any allocated storage here.
ここで割り当てられたストレージをすべてクリアします。

Returns: None.

Note: These init and fini functions are not the same as those described in the dlopen (3) system library.
注：これらのinitおよびfini関数は、dlopen（3）システムライブラリで説明されているものと同じではありません。
The C run-time system co-opts those symbols for its own initialization.
Cランタイムシステムは、独自の初期化のためにこれらのシンボルを採用します。
The system _init() is called before the Slurm init(), and the Slurm fini() is called before the system's _fini().
システム_init（）はSlurm init（）の前に呼び出され、Slurm fini（）はシステムの_fini（）の前に呼び出されます。

void *cred_read_private_key(const char *path);

Description: Generate a private key based upon the contents of the supplied file.
説明：提供されたファイルの内容に基づいて秘密鍵を生成します。

Argument:path (input) fully-qualified pathname to the private key as specified by the JobCredentialPrivateKey configuration parameter.
引数：path（入力）JobCredentialPrivateKey構成パラメーターで指定された秘密鍵への完全修飾パス名。

Returns: The pointer to a key on success or NULL on failure.
戻り値：成功した場合はキーへのポインタ、失敗した場合はNULLへのポインタ。
Call cred_p_destroy_key() to release memory associated with this key.
cred_p_destroy_key（）を呼び出して、このキーに関連付けられているメモリを解放します。

void *cred_p_read_public_key(const char *path);

Description: Generate a public key based upon the contents of the supplied file.
説明：提供されたファイルの内容に基づいて公開鍵を生成します。

Argument:path (input) fully-qualified pathname to the public key as specified by the JobCredentialPublicCertificate configuration parameter.
引数：path（入力）JobCredentialPublicCertificate構成パラメーターで指定された公開鍵への完全修飾パス名。

void cred_p_destroy_key(void *key);

Description: Release storage for a public or private key.
説明：公開鍵または秘密鍵のストレージを解放します。

Argument: key (input/output) pointer to the key previously allocated by cred_p_read_private_key() or cred_p_read_public_key().
引数：key（input / output）cred_p_read_private_key（）またはcred_p_read_public_key（）によって以前に割り当てられたキーへのポインター。

char *cred_p_str_error(void);

Description: Return a string describing the last error generated by the credential software.
説明：資格情報ソフトウェアによって生成された最後のエラーを説明する文字列を返します。

Returns: A pointer to a string.
戻り値：文字列へのポインタ。

int cred_p_sign(void *key, char *buffer, int buf_size, char **sig_pp, unsigned int *sig_size_p);

Description: Generate a signature for the supplied buffer.
説明：指定されたバッファーの署名を生成します。

Arguments:
key   (input) pointer to the key previously generated by cred_p_read_private_key() or cred_p_read_public_key().
key（入力）cred_p_read_private_key（）またはcred_p_read_public_key（）によって以前に生成されたキーへのポインター。

buffer   (input) data to be signed.
署名するバッファ（入力）データ。

buf_size   (input) size of buffer, in bytes.
buf_size（入力）バッファーのサイズ（バイト単位）。

sig_pp   (input/output) Location in which to store the signature.
sig_pp（入力/出力）署名を保存する場所。
NOTE: The storage for sig_pp should be allocated using xmalloc() and will be freed by the caller using xfree().
注：sig_ppのストレージは、xmalloc（）を使用して割り当てる必要があり、xfree（）を使用して呼び出し元によって解放されます。

sig_size_p   (input/output) Location in which to store the size of the signature (sig_pp).
sig_size_p（入力/出力）署名のサイズを格納する場所（sig_pp）。

Returns: SLURM_SUCCESS if successful.
戻り値：成功した場合はSLURM_SUCCESS。
On failure, the plugin should return SLURM_ERROR and set the errno to an appropriate value to indicate the reason for failure.
失敗した場合、プラグインはSLURM_ERRORを返し、errnoを適切な値に設定して失敗の理由を示す必要があります。

int cred_p_verify_sign(void *key, char *buffer, int buf_size, char *signature, unsigned int sig_size);

Description: Generate a signature for the supplied buffer.
説明：指定されたバッファーの署名を生成します。

Arguments:
key   (input) pointer to the key previously generated by cred_p_read_private_key() or cred_p_read_public_key().
key（入力）cred_p_read_private_key（）またはcred_p_read_public_key（）によって以前に生成されたキーへのポインター。

buffer   (input) data previously signed by cred_p_sign().
以前にcred_p_sign（）によって署名されたバッファ（入力）データ。

buf_size   (input) size of buffer, in bytes.
buf_size（入力）バッファーのサイズ（バイト単位）。

signature   (input) Signature as returned in sig_pp by the cred_p_sign() function and to be confirmed.
署名（入力）cred_p_sign（）関数によってsig_ppに返され、確認される署名。

sig_size   (input) Size of the signature as returned in sig_size_p by cred_p_sign().
sig_size（入力）cred_p_sign（）によってsig_size_pに返される署名のサイズ。

Last modified 7 January 2019