strlcpy

strlcpy はC言語げんごで文字もじ列れつを安全あんぜんにコピーするための関数かんすうである。ISO/IEC で規定きていされた標準ひょうじゅんCライブラリの関数かんすうではないが、BSD libc などに含ふくまれている。危険きけんな使つかい方かたをしてしまいがちな関数かんすうstrcpyやstrncpyの代替だいたいとして、Todd C. MillerおよびTheo de Raadt (テオ・デ・ラート) が開発かいはつした。

概要がいよう

関数かんすうプロトタイプ（宣言せんげん）は以下いかである。

size_t strlcpy(char *dst, const char *src, size_t size);

ポインタsrcの指さすアドレスから最大さいだいでsize - 1バイトの文字もじ列れつをdstにコピーし、dstの指さす文字もじ列れつが必かならずNUL文字もじで終おわるようにする。つまり、dstのバッファの実際じっさいの大おおきさをsizeに指定していすれば、バッファオーバーランしないことが保証ほしょうされる。

strncpyは似にたプロトタイプchar *strncpy(char *dest, const char *src, size_t count)を持もつが、最大さいだいでcountバイトをコピーするためNUL文字もじで終おわるとは限かぎらない点てんや、文字もじ列れつが短みじかい場合ばあいにdstの残のこった部分ぶぶんをすべてゼロで埋うめる点てんがstrlcpyと異ことなる。

実装じっそう状じょう況きょう

ToddとTheoはOpenBSDの開発かいはつ者しゃであり、strlcpyを最初さいしょに実装じっそうしたオペレーティングシステム (OS) はOpenBSD 2.4である。以後いご、FreeBSD 3.3を含ふくめ、SolarisやmacOS等ひとしの各かくOS、OpenSSL等ひとしのライブラリにも採用さいようされている。Linuxではlibbsdライブラリ経由けいゆで利用りようできる。

一方いっぽうで、GNU Cライブラリ (glibc) の開発かいはつ者しゃたちは、GNU Coding Standardsで禁きんじられている「長ながい行くだりを黙だまって切きり詰つめる」関数かんすうである、このような仕様しようの関数かんすうはバグである、いい加減かげんなプログラムを助長じょちょうしてしまう、新あらたなセキュリティ問題もんだいを生うむ、など否定ひてい的てきな見解けんかいを示しめしており、標準ひょうじゅん規格きかくに含ふくまれない限かぎりはglibcには実装じっそうしない意向いこうであった。しかし、POSIX仕様しようでの標準ひょうじゅん化かを受うけて2.38で実装じっそうされた。

Microsoft Visual C++には実装じっそうされていないが、バージョン8.0 (2005) 以降いこうはセキュリティ強化きょうかバージョンのCRT関数かんすうとして、出力しゅつりょくバッファサイズを受うけ取とりパラメータ検証けんしょうを実行じっこうするstrcpy_sが実装じっそうされている。strcpy_sはC11規格きかくで実装じっそう任意にんいのセキュリティ強化きょうか関数かんすうとして標準ひょうじゅん化かされている。

危険きけんな利用りよう例れい

安易あんいなstrlcpyの利用りようが、かえって危険きけんな結果けっかをもたらす例れいを以下いかに示しめす。

char cmd[] = "rm *.bak";
char buf[5];
strlcpy(buf, cmd, sizeof(buf));
system(buf);

sizeof(buf)が5であるため、最初さいしょの5 - 1すなわち4文字もじしかコピーされず、システムコール"rm *"（カレントディレクトリ内ないの全ぜんファイルの削除さくじょ）が実行じっこうされることになる。

本来ほんらいはstrlcpyの戻もどり値ちをチェックするなどして、文字もじ列れつがすべて意図いとした通とおりにコピーされたかどうかを確認かくにんすべきである。

関連かんれん項目こうもく

• strlcat - strcatの代替だいたい

脚注きゃくちゅう

外部がいぶリンク

• strlcpy(3) – FreeBSD Library Functions Manual Pages (en)