This revision was automatically updated to reflect the committed changes. Closed by commit rL362673: android: add a close-on-exec check on pipe() (authored by gbiv, committed by ). Herald added a project: LLVM. Herald added a subscriber: llvm-commits.
Changed prior to commit: https://reviews.llvm.org/D61967?vs=202984&id=203283#toc Repository: rL LLVM CHANGES SINCE LAST ACTION https://reviews.llvm.org/D61967/new/ https://reviews.llvm.org/D61967 Files: clang-tools-extra/trunk/clang-tidy/android/AndroidTidyModule.cpp clang-tools-extra/trunk/clang-tidy/android/CMakeLists.txt clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.cpp clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.h clang-tools-extra/trunk/docs/ReleaseNotes.rst clang-tools-extra/trunk/docs/clang-tidy/checks/android-cloexec-pipe.rst clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst clang-tools-extra/trunk/test/clang-tidy/android-cloexec-pipe.cpp
Index: clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.h =================================================================== --- clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.h +++ clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.h @@ -0,0 +1,34 @@ +//===--- CloexecPipeCheck.h - clang-tidy-------------------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_PIPE_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_PIPE_H + +#include "CloexecCheck.h" + +namespace clang { +namespace tidy { +namespace android { + +/// Suggests to replace calls to pipe() with calls to pipe2(). +/// +/// For the user-facing documentation see: +/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-pipe.html +class CloexecPipeCheck : public CloexecCheck { +public: + CloexecPipeCheck(StringRef Name, ClangTidyContext *Context) + : CloexecCheck(Name, Context) {} + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; +}; + +} // namespace android +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_PIPE_H Index: clang-tools-extra/trunk/clang-tidy/android/AndroidTidyModule.cpp =================================================================== --- clang-tools-extra/trunk/clang-tidy/android/AndroidTidyModule.cpp +++ clang-tools-extra/trunk/clang-tidy/android/AndroidTidyModule.cpp @@ -20,6 +20,7 @@ #include "CloexecInotifyInitCheck.h" #include "CloexecMemfdCreateCheck.h" #include "CloexecOpenCheck.h" +#include "CloexecPipeCheck.h" #include "CloexecPipe2Check.h" #include "CloexecSocketCheck.h" #include "ComparisonInTempFailureRetryCheck.h" @@ -50,6 +51,7 @@ CheckFactories.registerCheck<CloexecMemfdCreateCheck>( "android-cloexec-memfd-create"); CheckFactories.registerCheck<CloexecOpenCheck>("android-cloexec-open"); + CheckFactories.registerCheck<CloexecPipeCheck>("android-cloexec-pipe"); CheckFactories.registerCheck<CloexecPipe2Check>("android-cloexec-pipe2"); CheckFactories.registerCheck<CloexecSocketCheck>("android-cloexec-socket"); CheckFactories.registerCheck<ComparisonInTempFailureRetryCheck>( Index: clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.cpp =================================================================== --- clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.cpp +++ clang-tools-extra/trunk/clang-tidy/android/CloexecPipeCheck.cpp @@ -0,0 +1,37 @@ +//===--- CloexecPipeCheck.cpp - clang-tidy---------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "CloexecPipeCheck.h" +#include "clang/AST/ASTContext.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { +namespace android { + +void CloexecPipeCheck::registerMatchers(MatchFinder *Finder) { + registerMatchersImpl(Finder, + functionDecl(returns(isInteger()), hasName("pipe"), + hasParameter(0, hasType(pointsTo(isInteger()))))); +} + +void CloexecPipeCheck::check(const MatchFinder::MatchResult &Result) { + std::string ReplacementText = + (Twine("pipe2(") + getSpellingArg(Result, 0) + ", O_CLOEXEC)").str(); + + replaceFunc( + Result, + "prefer pipe2() with O_CLOEXEC to avoid leaking file descriptors to child processes", + ReplacementText); +} + +} // namespace android +} // namespace tidy +} // namespace clang Index: clang-tools-extra/trunk/clang-tidy/android/CMakeLists.txt =================================================================== --- clang-tools-extra/trunk/clang-tidy/android/CMakeLists.txt +++ clang-tools-extra/trunk/clang-tidy/android/CMakeLists.txt @@ -14,6 +14,7 @@ CloexecInotifyInitCheck.cpp CloexecMemfdCreateCheck.cpp CloexecOpenCheck.cpp + CloexecPipeCheck.cpp CloexecPipe2Check.cpp CloexecSocketCheck.cpp ComparisonInTempFailureRetryCheck.cpp Index: clang-tools-extra/trunk/docs/ReleaseNotes.rst =================================================================== --- clang-tools-extra/trunk/docs/ReleaseNotes.rst +++ clang-tools-extra/trunk/docs/ReleaseNotes.rst @@ -101,6 +101,11 @@ Finds and fixes ``absl::Time`` subtraction expressions to do subtraction in the Time domain instead of the numeric domain. +- New :doc:`android-cloexec-pipe + <clang-tidy/checks/android-cloexec-pipe>` check. + + This check detects usage of ``pipe()``. + - New :doc:`android-cloexec-pipe2 <clang-tidy/checks/android-cloexec-pipe2>` check. Index: clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst =================================================================== --- clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst +++ clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst @@ -32,6 +32,7 @@ android-cloexec-inotify-init1 android-cloexec-memfd-create android-cloexec-open + android-cloexec-pipe android-cloexec-pipe2 android-cloexec-socket android-comparison-in-temp-failure-retry Index: clang-tools-extra/trunk/docs/clang-tidy/checks/android-cloexec-pipe.rst =================================================================== --- clang-tools-extra/trunk/docs/clang-tidy/checks/android-cloexec-pipe.rst +++ clang-tools-extra/trunk/docs/clang-tidy/checks/android-cloexec-pipe.rst @@ -0,0 +1,20 @@ +.. title:: clang-tidy - android-cloexec-pipe + +android-cloexec-pipe +==================== + +This check detects usage of ``pipe()``. Using ``pipe()`` is not recommended, ``pipe2()`` is the +suggested replacement. The check also adds the O_CLOEXEC flag that marks the file descriptor to +be closed in child processes. Without this flag a sensitive file descriptor can be leaked to a +child process, potentially into a lower-privileged SELinux domain. + +Examples: + +.. code-block:: c++ + + pipe(pipefd); + +Suggested replacement: + +.. code-block:: c++ + pipe2(pipefd, O_CLOEXEC); Index: clang-tools-extra/trunk/test/clang-tidy/android-cloexec-pipe.cpp =================================================================== --- clang-tools-extra/trunk/test/clang-tidy/android-cloexec-pipe.cpp +++ clang-tools-extra/trunk/test/clang-tidy/android-cloexec-pipe.cpp @@ -0,0 +1,27 @@ +// RUN: %check_clang_tidy %s android-cloexec-pipe %t + +extern "C" int pipe(int pipefd[2]); + +void warning() { + int pipefd[2]; + pipe(pipefd); + // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: prefer pipe2() with O_CLOEXEC to avoid leaking file descriptors to child processes [android-cloexec-pipe] + // CHECK-FIXES: pipe2(pipefd, O_CLOEXEC); +} + +namespace i { +int pipe(int pipefd[2]); +void noWarningInNamespace() { + int pipefd[2]; + pipe(pipefd); +} +} // namespace i + +class C { +public: + int pipe(int pipefd[2]); + void noWarningForMemberFunction() { + int pipefd[2]; + pipe(pipefd); + } +};
_______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
