C 安全関数

C 言語では、コードの安全性を高めるために、特にバッファオーバーフローなどの一般的なセキュリティ問題を防ぐために、C11 標準ではいくつかの安全関数(Annex K標準ライブラリ関数とも呼ばれる)を導入しました。これらの安全関数は、主に標準の文字列操作関数とメモリ操作関数の拡張版であり、バッファサイズなどのパラメータを追加することで、より優れたエラー検出と処理を提供します。

安全関数の特徴:

  • バッファサイズのチェック:すべての安全関数は、バッファオーバーフローを防ぐために、宛先バッファのサイズパラメータを渡すことを要求します。
  • 戻り値のチェック:ほとんどの関数はerrno_t型のエラーコードを返すため、関数が正常に実行されたかどうかを確認できます。
  • より良いエラー処理:バッファサイズが足りない場合やその他の問題が発生した場合、これらの関数はエラーコードを返し、出力バッファをクリアまたは初期化しようとします。

安全関数は Visual Studio などのコンパイラでよくサポートされていますが、一部の古いバージョンのコンパイラでは利用できない場合があるため、互換性に注意する必要があります。

以下は、C で一般的な安全関数と、それに対応する従来の関数との比較です:

1、安全な文字列操作関数

strcpy_s:strcpy の安全版で、文字列をコピーし、宛先バッファサイズをチェックします。

errno_t strcpy_s(char *dest, rsize_t destsz, const char *src);

strcat_s:strcat の安全版で、ソース文字列を宛先文字列の末尾に追加し、バッファサイズをチェックします。

errno_t strcat_s(char *dest, rsize_t destsz, const char *src);

strncpy_s:strncpy の安全版で、最大 n 文字をコピーし、バッファサイズをチェックします。

errno_t strncpy_s(char *dest, rsize_t destsz, const char *src, rsize_t count);

strncat_s:strncat の安全版で、最大 n 文字を宛先文字列の末尾に追加し、バッファサイズをチェックします。

errno_t strncat_s(char *dest, rsize_t destsz, const char *src, rsize_t count);

strtok_s:strtok の安全版で、コンテキストパラメータを導入し、スレッドセーフティの問題を解決します。

char *strtok_s(char *str, const char *delim, char **context);

2、フォーマット出力安全関数

sprintf_s:sprintf の安全版で、文字列へのフォーマット出力時にバッファサイズをチェックします。

int sprintf_s(char *buffer, rsize_t buffer_size, const char *format, ...);

snprintf_s:snprintf の安全版で、フォーマット出力時に文字数を制限し、バッファサイズをチェックします。

int snprintf_s(char *buffer, rsize_t buffer_size, const char *format, ...);

vsprintf_s:vsprintf の安全版で、va_list パラメータリストを受け取り、バッファサイズをチェックします。

int vsprintf_s(char *buffer, rsize_t buffer_size, const char *format, va_list argptr);

3、メモリ操作安全関数

memcpy_s:memcpy の安全版で、メモリ領域をコピーする際に宛先バッファサイズをチェックします。

errno_t memcpy_s(void *dest, rsize_t destsz, const void *src, rsize_t count);

memmove_s:memmove の安全版で、メモリ領域をコピーし、重複を許可し、宛先バッファサイズをチェックします。

errno_t memmove_s(void *dest, rsize_t destsz, const void *src, rsize_t count);

memset_s:memset の安全版で、指定された文字をメモリブロックに書き込み、バッファサイズをチェックします。

errno_t memset_s(void *dest, rsize_t destsz, int ch, rsize_t count);

4、その他の一般的な安全関数

_itoa_sと_ultoa_s:整数変換関数の安全版で、整数を文字列に変換する際に宛先バッファサイズをチェックします。

errno_t _itoa_s(int value, char *buffer, size_t buffer_size, int radix);
errno_t _ultoa_s(unsigned long value, char *buffer, size_t buffer_size, int radix);

_strlwr_sと_strupr_s:文字列を小文字または大文字に変換する安全版です。

errno_t _strlwr_s(char *str, size_t numberOfElements);
errno_t _strupr_s(char *str, size_t numberOfElements);

例

以下は、C 安全関数を使用した文字列操作とメモリ操作の例であり、一般的なバッファオーバーフローの問題を回避し、より安全なプログラミング方法を提供する方法を示しています。

例1:strcpy_s と strcat_s

例

#include <stdio.h>
#include <string.h>

int main() {
    char dest[20]; // 宛先バッファサイズは 20
    const char *src = "Hello, World!";

    // strcpy_s を使用して src を dest にコピー
    if (strcpy_s(dest, sizeof(dest), src) != 0) {
        printf("strcpy_s failed!\n");
        return 1; // エラーコードを返す
    } else {
        printf("After strcpy_s: %s\n", dest);
    }

    // strcat_s を使用して " C Language" を dest に追加
    const char *appendStr = " C Language";
    if (strcat_s(dest, sizeof(dest), appendStr) != 0) {
        printf("strcat_s failed!\n");
        return 1; // エラーコードを返す
    } else {
        printf("After strcat_s: %s\n", dest);
    }

    return 0;
}

出力:

After strcpy_s: Hello, World!
strcat_s failed!

上記のコードでは、strcpy_s は文字列 "Hello, World!" を dest に正常にコピーしましたが、dest のサイズは 20 であり、"Hello, World! C Language" を格納するには不十分なため、strcat_s はバッファ不足を検出してエラーコードを返します。

例2:memcpy_s

例

#include <stdio.h>
#include <string.h>

int main() {
    char src[] = "Sensitive Data";
    char dest[15]; // 宛先バッファサイズは 15

    // memcpy_s を使用してデータを dest にコピー
    if (memcpy_s(dest, sizeof(dest), src, strlen(src) + 1) != 0) {
        printf("memcpy_s failed!\n");
        return 1; // エラーコードを返す
    } else {
        printf("After memcpy_s: %s\n", dest);
    }

    return 0;
}

出力:

After memcpy_s: Sensitive Data

この例では、memcpy_s は宛先バッファ dest が src のデータ(文字列末尾のヌル文字を含む)を格納するのに十分な大きさがあるかどうかをチェックします。destsz が strlen(src) + 1 より小さい場合、関数はエラーを返し、メモリコピーを実行しません。

例3:strtok_s

例

#include <stdio.h>
#include <string.h>

int main() {
    char str[] = "apple,orange,banana";
    char *token;
    char *context = NULL;

    // strtok_s を使用して文字列を分割
    token = strtok_s(str, ",", &context);
    while (token != NULL) {
        printf("Token: %s\n", token);
        token = strtok_s(NULL, ",", &context);
    }

    return 0;
}

出力:

Token: apple
Token: orange
Token: banana

この例では、strtok_s は文字列を分割する際に context パラメータを使用してコンテキスト情報を保存するため、strtok のスレッドセーフではない問題を回避しています。

例4:sprintf_s

例

#include <stdio.h>

int main() {
    char buffer[50];
    int num = 42;
    const char *str = "Hello";

    // sprintf_s を使用して文字列をフォーマットし、バッファサイズをチェック
    if (sprintf_s(buffer, sizeof(buffer), "Number: %d, String: %s", num, str) < 0) {
        printf("sprintf_s failed!\n");
        return 1; // エラーコードを返す
    } else {
        printf("Formatted String: %s\n", buffer);
    }

    return 0;
}

出力:

Formatted String: Number: 42, String: Hello

ここでは、sprintf_s は文字列をフォーマットする際にバッファサイズをパラメータとして受け取ります。フォーマット後の文字列が buffer のサイズを超えた場合、関数はエラーを返すため、バッファオーバーフローを回避できます。

上記の例は、C 安全関数を使用した文字列コピー、連結、メモリコピー、文字列分割、フォーマット出力の方法を示しています。これらの関数はバッファサイズのチェックを提供し、コードの安全性を大幅に向上させます。


参考マニュアル

安全関数は主にバッファオーバーフロー(Buffer Overflow)を防ぐためのものです。この種の脆弱性は、通常、関数が宛先バッファのサイズをチェックしないことに起因します。

現在主流の安全関数標準は、主に C11 標準の Annex K(境界チェックインターフェース)と、各オペレーティングシステム(Windows の MSVC CRT など)が提供する拡張バージョンに由来しています。

以下の表は、C 安全関数の参考表です。

1、文字列処理

これは最もオーバーフローが発生しやすい箇所であり、安全関数は通常、宛先バッファのサイズを渡すことを要求します。

元の関数(安全ではない) 安全な代替関数 主な改善点
strcpy strcpy_s 宛先バッファサイズのパラメータを追加。ソース文字列が長すぎる場合は、制約ハンドラを呼び出します。
strcat strcat_s 宛先バッファの残り容量のパラメータを追加し、連結時の範囲外アクセスを防ぎます。
strncpy strncpy_s 宛先文字列が\0で終わることを保証し、実行時エラーチェックを追加します。
strtok strtok_s コンテキストポインタ(Context)を導入し、スレッドセーフでより堅牢になりました。
strlen strnlen_s 最大チェック長を追加し、\0がない不良データ内で無限ループすることを防ぎます。

2、フォーマット入力/出力

安全ではないフォーマット関数は、フォーマット文字列の脆弱性やバッファオーバーフローを引き起こす可能性があります。

元の関数(安全ではない) 安全な代替関数 主な改善点
sprintf snprintf / sprintf_s snprintf書き込み文字数を制限。sprintf_sフォーマット文字列の正当性をチェック。
vsprintf vsnprintf_s バッファサイズ制限を追加し、可変引数リストに適用。
scanf scanf_s に対して%sと%cなどの変換指定子、強制的にバッファサイズの提供を要求します。
fscanf fscanf_s ファイル入力の読み取り時に長さ制限を追加。
sscanf sscanf_s 文字列からの読み取り時に長さ制限を追加。

3、標準入力/出力
元の関数(安全ではない) 安全な代替関数 主な改善点
gets gets_s / fgets getsC11 では廃止されました。gets_s読み取り上限を指定する必要があります。
tmpnam tmpnam_s 一時ファイル名を生成するためのバッファサイズのチェックが追加されました。

4、メモリ操作

元の関数(安全ではない) 安全な代替関数 主な改善点
memcpy memcpy_s 宛先バッファサイズのチェックを追加。重複やオーバーフローが発生した場合は、エラーを返します。
memmove memmove_s 重複するメモリ領域を処理する際にサイズ制限チェックを追加。
memset memset_s コンパイラが最適化によってメモリ消去操作をスキップしないことを保証します(パスワードなどの機密データの消去によく使用されます)。
その他の拡張