Retour aux résultats
  • Linux

Guide complet : Comment utiliser un script Linux pour vérifier l’existence d’un fichier ou d’un dossier ?

  • by Team Ninja

Garantir l’intégrité et la présence des fichiers et répertoires critiques est primordial dans la gestion informatique. Que vous soyez un professionnel de l’informatique ou un fournisseur de services gérés (MSP), le suivi des fichiers système essentiels ou des répertoires d’applications spécifiques peut contribuer à maintenir la stabilité, la sécurité et la conformité du système. C’est là que les scripts d’automatisation entrent en jeu, en particulier celui qui peut vous alerter si un fichier ou un dossier spécifique est trouvé dans un répertoire ou un sous-répertoire.

Contexte

Le script fourni offre une solution robuste de recherche et d’alerte basée sur l’existence de fichiers ou de dossiers dans un chemin d’accès spécifié. Ce type d’automatisation est crucial dans divers scénarios, tels que la vérification du succès du déploiement, le contrôle des modifications non autorisées ou la garantie que les configurations critiques sont en place. Pour les professionnels de l’informatique et les MSP, l’utilisation de ces scripts peut améliorer l’efficacité opérationnelle et réduire les efforts de surveillance manuelle.

Le script

#!/usr/bin/env bash

# Description: Alert if a specified file or folder is found in a directory or subdirectory you specify.
#
# Release Notes: Initial Release
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#
# Below are all the (case sensitive) valid parameters for this script.
# Only the path to search and name of file or folder are required!
#
# Parameter: --path "/opt/NinjaRMM/programdata"
#   Required
#   Base path to search for files or folders.
#
# Parameter: --name "ninjarmm-cli"
#   Required
#   Name of the file or folder to search for.
#   Notes:
#       If the name is not provided, the script will search for the path only.
#       This is case sensitive and accepts wildcards.
#
# Parameter: --type "Files Or Folders"
#   Required
#   Search for files or folders.
#
# Parameter: --type "Files Only"
#   Required
#   Searches for files only.
#
# Parameter: --type "Folders Only"
#   Required
#   Searches for folder only.
#
# Parameter: --timeout 10
#   Optional and defaults to 30 minutes
#   Time in minutes to wait for the search to complete before timing out.
#
# Parameter: --customfield "myCustomField"
#   Optional
#   Custom Field to save the search results to.

die() {
    local _ret="${2:-1}"
    test "${_PRINT_HELP:-no}" = yes && print_help >&2
    echo "$1" >&2
    exit "${_ret}"
}

begins_with_short_option() {
    local first_option all_short_options='h'
    first_option="${1:0:1}"
    test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
}

# Initize arguments
_arg_path=
_arg_name=
_arg_type=
_arg_timeout=30
_arg_customfield=

print_help() {
    printf '%s\n' "Check existence of a file or folder"
    printf 'Usage: %s [--path <arg>] [--name <arg>] [--type <"Files Only"|"Folders Only"|"Files Or Folders">] [--timeout <30>] [--customfield <arg>] [-h|--help]\n' "$0"
    printf '\t%s\n' "-h, --help: Prints help"
}

parse_commandline() {
    while test $# -gt 0; do
        _key="$1"
        case "$_key" in
        --path)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_path="$2"
            shift
            ;;
        --path=*)
            _arg_path="${_key##--path=}"
            ;;
        --name)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_name="$2"
            shift
            ;;
        --name=*)
            _arg_name="${_key##--name=}"
            ;;
        --type)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_type="$2"
            shift
            ;;
        --type=*)
            _arg_type="${_key##--type=}"
            ;;
        --timeout)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_timeout="$2"
            shift
            ;;
        --timeout=*)
            _arg_timeout="${_key##--timeout=}"
            ;;
        --customfield)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_customfield="$2"
            shift
            ;;
        --customfield=*)
            _arg_customfield="${_key##--customfield=}"
            ;;
        -h | --help)
            print_help
            exit 0
            ;;
        -h*)
            print_help
            exit 0
            ;;
        *)
            _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
            ;;
        esac
        shift
    done
}

parse_commandline "$@"

function SetCustomField() {
    customfieldName=$1
    customfieldValue=$2
    if [ -f "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
        if [ -x "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
            if "$NINJA_DATA_PATH"/ninjarmm-cli get "$customfieldName" >/dev/null; then
                # check if the value is greater than 10000 characters
                if [ ${#customfieldValue} -gt 10000 ]; then
                    echo "[Warn] Custom field value is greater than 10000 characters"
                fi
                if ! echo "${customfieldValue::10000}" | "$NINJA_DATA_PATH"/ninjarmm-cli set --stdin "$customfieldName"; then
                    echo "[Warn] Failed to set custom field"
                else
                    echo "[Info] Custom field value set successfully"
                fi
            else
                echo "[Warn] Custom Field ($customfieldName) does not exist or agent does not have permission to access it"
            fi
        else
            echo "[Warn] ninjarmm-cli is not executable"
        fi
    else
        echo "[Warn] ninjarmm-cli does not exist"
    fi
}

parentSearchPath=$_arg_path
leafSearchName=$_arg_name
searchType=$_arg_type
timeout=$_arg_timeout
customField=$_arg_customfield

# Get values from Script Variables
if [[ -n "${pathToSearch}" ]]; then
    parentSearchPath="${pathToSearch}"
fi
if [[ -n "${nameOfFileOrFolder}" ]]; then
    leafSearchName="${nameOfFileOrFolder}"
fi
if [[ -n "${filesOrFolders}" && "${filesOrFolders}" != "null" ]]; then
    searchType="${filesOrFolders}"
fi
if [[ -n "${searchTimeout}" && "${searchTimeout}" != "null" ]]; then
    timeout="${searchTimeout}"
fi
if [[ -n "${customFieldName}" && "${customFieldName}" != "null" ]]; then
    customField="${customFieldName}"
fi

if [[ -z "${parentSearchPath}" ]]; then
    echo "[Error] Path to Search is empty"
    exit 1
fi

# Check if path exists
if [ -e "${parentSearchPath}" ]; then
    echo "[Info] Path ${parentSearchPath} exists"
else
    echo "[Error] Path to Search ${parentSearchPath} does not exist or is an invalid path"
    exit 1
fi

# Check if timeout is a number
if ! [[ "${timeout}" =~ ^[0-9]+$ ]]; then
    echo "[Error] Timeout is not a number"
    exit 1
fi
# Check if timeout is not in the range of 1 to 120
if [[ "${timeout}" -lt 1 || "${timeout}" -gt 120 ]]; then
    echo "[Error] Timeout is not in the range of 1 to 120"
    exit 1
fi

# Search for files or folders
if [[ -n "${leafSearchName}" && "${leafSearchName}" != "null" ]]; then
    if [[ "${searchType}" == *"Files"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for files only"
        # Search for files only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -type f -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Folders"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for folders only"
        # Search for folders only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -type d -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        echo "[Info] Searching for files or folders"
        # Search for files or folders
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    else
        echo "[Error] Invalid search type"
        echo "Valid search types: Files Only, Folders Only, Files Or Folders"
        exit 1
    fi
elif [[ -z "${leafSearchName}" ]]; then
    # Search in path only
    echo "[Info] Searching in path only"
    # Search in path only
    # Use timeout to prevent the find command from running indefinitely
    foundPath=$(timeout "${timeout}m" find "$parentSearchPath")
    exitcode=$?
    if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
        if [[ -n $foundPath ]]; then
            echo "[Alert] File Found"
        fi
    fi
fi

# Check exit code
if [[ -n $foundPath ]]; then
    if [[ -n "${foundPath}" ]]; then
        # Split the string into an array
        IFS=$'\n' read -rd '' -a foundPathArray <<<"${foundPath}"
        # Print each element of the array
        for element in "${foundPathArray[@]}"; do
            echo "[Alert] ${element} exists"
        done
    elif [[ -z "${foundPath}" ]]; then
        echo "[Info] ${foundPath} does not exist"
    fi
elif [[ -z $foundPath ]]; then
    echo "[Warn] Could not find a file or folder"
    exit 1
else
    # If the find command fails to find the file or folder

    # Figure out the grammer for the search type
    if [[ "${searchType}" == *"Only"* ]]; then
        if [[ "${searchType}" == *"Files"* ]]; then
            searchTypeInfo="file"
        elif [[ "${searchType}" == *"Folders"* ]]; then
            searchTypeInfo="folder"
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        searchTypeInfo="file or folder"
    fi
    echo "[Info] Could not find a ${searchTypeInfo} in the path ${parentSearchPath} with the name containing: ${leafSearchName}"
fi

# If command times out
if [[ $exitcode -ge 124 && $exitcode -le 127 || $exitcode -eq 137 ]]; then
    echo "[Alert] Timed out searching for file or folder"
    echo "timeout exit code: $exitcode"
    echo "  124  if COMMAND times out, and --preserve-status is not specified"
    echo "  125  if the timeout command itself fails"
    echo "  126  if COMMAND is found but cannot be invoked"
    echo "  127  if COMMAND cannot be found"
    echo "  137  if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9)"
    echo "find command result: $foundPath"
    exit 1
fi

# Save to custom field
if [[ -n "${customField}" && "${customField}" != "null" ]]; then
    SetCustomField "${customField}" "${foundPath}"
fi

 

Description détaillée

Nous allons nous plonger dans le script pour comprendre son fonctionnement, ses paramètres et ses fonctionnalités :

Paramètres et options

Le script accepte plusieurs paramètres pour personnaliser l’opération de recherche :

  • –chemin « /opt/NinjaRMM/programdata » : Spécifie le chemin de base pour la recherche de fichiers ou de dossiers. Ce paramètre est obligatoire.
  • –nom « ninjarmm-cli » : Définit le nom du fichier ou du dossier à rechercher. Il est également obligatoire et prend en charge la sensibilité à la casse et les caractères génériques.
  • –type « Files Or Folders » : Détermine si la recherche doit porter sur les fichiers, les dossiers ou les deux. Paramètre obligatoire avec options :
  • Fichiers uniquement
  • Dossiers uniquement
  • Fichiers ou dossiers
  • –timeout 10 : Un paramètre facultatif spécifiant le temps (en minutes) à attendre pour que la recherche se termine avant de s’arrêter, la valeur par défaut étant de 30 minutes.
  • –champ personnalisé « myCustomField » : Paramètre facultatif permettant d’enregistrer les résultats de la recherche dans un champ personnalisé.

Flux d’exécution des scripts

1. Arguments d’initialisation et d’analyse : Le script commence par définir des fonctions utilitaires (die et begins_with_short_option) et initialiser les variables d’argument. La fonction parse_commandline traite les arguments fournis, les valide et les affecte aux variables correspondantes.

2. SetCustomField Fonction : Cette fonction définit un champ personnalisé avec les résultats de la recherche si l’outil ninjarmm-cli est disponible et exécutable. Il vérifie diverses conditions, telles que l’existence de l’outil et du champ personnalisé, et gère les contraintes de longueur des valeurs.

3. Logique principale :

  • Le script valide le paramètre de chemin requis et s’assure que le répertoire spécifié existe.
  • Il vérifie si la valeur du délai d’attente est un nombre compris dans la fourchette acceptable (1 à 120 minutes).
  • En fonction du type spécifié (Fichiers uniquement, Dossiers uniquement, Fichiers ou Dossiers), il effectue la recherche à l’aide de la commande find avec un délai d’attente pour éviter une exécution indéfinie.
  • Les résultats de la recherche sont traités de manière appropriée, en alertant si le fichier ou le dossier est trouvé et en enregistrant les résultats dans un champ personnalisé si cela est spécifié.

Cas d’utilisation potentiels

  1. Vérification du déploiement : S’assurer que les fichiers critiques sont présents après le déploiement pour confirmer la réussite de l’installation de l’application.
  2. Surveillance de la sécurité : Détecter les ajouts non autorisés de fichiers ou de répertoires, ce qui pourrait indiquer une faille de sécurité ou une violation de la politique.
  3. Audits de conformité : Vérifier la présence des fichiers de configuration ou des journaux nécessaires au respect des normes industrielles.

Étude de cas hypothétique

Imaginez un MSP gérant plusieurs environnements clients. En déployant ce script sur les systèmes des clients, le MSP peut automatiser le processus de vérification des fichiers importants, tels que les définitions d’antivirus ou les configurations du système, en s’assurant qu’ils sont à jour et conformes aux politiques de sécurité. En cas de divergence, le script alerte l’entreprise MSP, ce qui permet de remédier rapidement à la situation.

Comparaisons

Les méthodes traditionnelles de vérification de l’existence d’un fichier peuvent impliquer des commandes manuelles ou des scripts de base dépourvus d’options robustes de gestion des erreurs et de personnalisation. Le script fourni se distingue par un paramétrage complet, la gestion des délais et l’intégration de champs personnalisés pour le stockage des résultats. Ce niveau d’automatisation et de flexibilité améliore considérablement l’efficacité opérationnelle.

FAQ

Q : Ce script peut-il rechercher plusieurs fichiers ou dossiers à la fois ?

R : Non, le script est conçu pour rechercher un seul fichier ou dossier spécifié. Des recherches multiples nécessiteraient l’exécution de plusieurs scripts.

Q : Comment le script gère-t-il les grands répertoires ?

R : Le script utilise la commande find avec un délai d’attente pour éviter les recherches trop longues. Cela permet d’éviter qu’il ne se bloque indéfiniment dans les grands répertoires.

Q : Que se passe-t-il si l’outil ninjarmm-cli n’est pas disponible ?

R : Le script enregistre un avertissement et poursuit son opération. La fonctionnalité de champ personnalisé sera ignorée si l’outil n’est pas exécutable.

Implications

La possibilité d’automatiser les contrôles d’existence des fichiers et des dossiers a des implications significatives pour la sécurité et la gestion des technologies de l’information. Des alertes automatisées permettent d’identifier rapidement les changements non autorisés, les violations potentielles et les problèmes de conformité. Cette approche proactive renforce la sécurité et la fiabilité globales du système.

Recommandations

  • Définir des délais d’attente appropriés : Veillez à ce que la valeur du délai d’attente soit adaptée à la taille du répertoire afin d’éviter les interruptions inutiles de scripts.
  • Mettre régulièrement à jour les critères de recherche : Adapter les paramètres de recherche en fonction de l’évolution des besoins, tels que de nouveaux fichiers ou répertoires critiques.
  • Intégrer les systèmes de surveillance : Utilisez la fonctionnalité de champ personnalisé pour intégrer des systèmes de surveillance et d’alerte plus vastes, afin d’obtenir une vue unifiée de la santé et de la conformité du système.

Conclusion

Les scripts d’automatisation tels que celui présenté ici sont des outils inestimables pour les professionnels de l’informatique et les MSP. Ils constituent un moyen fiable et efficace de s’assurer que les fichiers et les répertoires essentiels sont présents et corrects. En intégrant ce script dans vos pratiques de gestion informatique, vous pouvez améliorer la sécurité, la conformité et l’efficacité opérationnelle. NinjaOne offre une suite d’outils qui peuvent compléter ces scripts, fournissant des solutions de gestion informatique complètes adaptées à vos besoins.

Pour aller plus loin

Créer une équipe informatique efficace et performante nécessite une solution centralisée qui soit l’outil principal pour fournir vos services. NinjaOne permet aux équipes informatiques de surveiller, gérer, sécuriser et prendre en charge tous les appareils, où qu’ils soient, sans avoir besoin d’une infrastructure complexe sur site.

Pour en savoir plus sur NinjaOne Endpoint Management, participez à une visite guidée ou commencez votre essai gratuit de la plateforme NinjaOne.

Commencez votre essai gratuit

Catégories :

  • Surveillance

Vous pourriez aussi aimer

×

Voir NinjaOne en action !

En soumettant ce formulaire, j'accepte la politique de confidentialité de NinjaOne.

Download the script

Termes et conditions NinjaOne

En cliquant sur le bouton « J’accepte » ci-dessous, vous indiquez que vous acceptez les termes juridiques suivants ainsi que nos conditions d’utilisation:

  • Droits de propriété: NinjaOne possède et continuera de posséder tous les droits, titres et intérêts relatifs au script (y compris les droits d’auteur). NinjaOne vous accorde une licence limitée pour l’utilisation du script conformément à ces conditions légales.
  • Limitation de l’utilisation: Les scripts ne peuvent être utilisés qu’à des fins personnelles ou professionnelles internes légitimes et ne peuvent être partagés avec d’autres entités.
  • Interdiction de publication: Vous n’êtes en aucun cas autorisé à publier le script dans une bibliothèque de scripts appartenant à, ou sous le contrôle d’un autre fournisseur de logiciels.
  • Clause de non-responsabilité: Le texte est fourni « tel quel » et « tel que disponible », sans garantie d’aucune sorte. NinjaOne ne promet ni ne garantit que le script sera exempt de défauts ou qu’il répondra à vos besoins ou attentes particulières.
  • Acceptation des risques: L’utilisation du script est sous votre propre responsabilité. Vous reconnaissez qu’il existe certains risques inhérents à l’utilisation du script, et vous comprenez et assumez chacun de ces risques.
  • Renonciation et exonération de responsabilité: Vous ne tiendrez pas NinjaOne pour responsable des conséquences négatives ou involontaires résultant de votre utilisation du script, et vous renoncez à tout droit ou recours légal ou équitable que vous pourriez avoir contre NinjaOne en rapport avec votre utilisation du script.
  • EULA: Si vous êtes un client de NinjaOne, votre utilisation du script est soumise au contrat de licence d’utilisateur final qui vous est applicable (End User License Agreement (EULA)).
J'accepte