Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add file permission check workflow #8922

Merged
merged 1 commit into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/test-file-permissions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Check File Permissions

on:
pull_request:
push:

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

permissions:
contents: read

jobs:
permission-check:
name: Check File Permission
runs-on: ubuntu-22.04

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Detect unnecessary execution permissions
run: php utils/check_permission_x.php
95 changes: 95 additions & 0 deletions utils/check_permission_x.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php

declare(strict_types=1);

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <[email protected]>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace Utils;

require __DIR__ . '/../system/Test/bootstrap.php';

use CodeIgniter\CLI\CLI;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RuntimeException;

function findExecutableFiles($dir)
{
$execFileList = [
'admin/release-userguide',
'admin/release-deploy',
'admin/apibot',
'admin/alldocs',
'admin/release',
'admin/docbot',
'admin/release-notes.bb',
'admin/release-revert',
'admin/starter/builds',
'user_guide_src/add-edit-this-page',
];

$executableFiles = [];

// Check if the directory exists
if (! is_dir($dir)) {
throw new RuntimeException('No such directory: ' . $dir);
}

// Create a Recursive Directory Iterator
$iterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($dir)
);

// Iterate over each item in the directory
foreach ($iterator as $fileinfo) {
// Check if the item is a file and is executable
if ($fileinfo->isFile() && is_executable($fileinfo->getPathname())) {
$filePath = $fileinfo->getPathname();

// Check allow list
if (in_array($filePath, $execFileList, true)) {
continue;
}

if (str_ends_with($filePath, '.sh')) {
continue;
}

$executableFiles[] = $filePath;
}
}

return $executableFiles;
}

// Main
chdir(__DIR__ . '/../');

$dirs = ['admin', 'app', 'system', 'tests', 'user_guide_src', 'utils', 'writable'];

$executableFiles = [];

foreach ($dirs as $dir) {
$executableFiles = array_merge($executableFiles, findExecutableFiles($dir));
}

if ($executableFiles !== []) {
CLI::write('Files with unnecessary execution permissions were detected:', 'light_gray', 'red');

foreach ($executableFiles as $file) {
CLI::write('- ' . $file);
}

exit(1);
}

CLI::write('No files with unnecessary execution permissions were detected.', 'black', 'green');

exit(0);