Comment utiliser un script Shell pour détecter les comptes utilisateurs inactifs sur macOS

La gestion des comptes d’utilisateurs est un aspect crucial de l’administration informatique. Veiller à ce que les comptes utilisateurs inactifs ou inutilisés soient signalés et traités rapidement est essentiel pour maintenir la sécurité et l’efficacité. Cet article présente un script shell conçu pour alerter les administrateurs au sujet des comptes utilisateurs inactifs sur les systèmes macOS. Ce script est un outil essentiel pour les professionnels de l’informatique et les fournisseurs de services gérés (MSP) qui souhaitent renforcer leur sécurité et améliorer la gestion des comptes.

Contexte

Les comptes inactifs présentent des risques importants pour la sécurité. Ils peuvent être exploités par des personnes malveillantes pour obtenir un accès non autorisé aux systèmes. Dans les grandes entreprises, il n’est pas pratique de suivre manuellement l’activité des utilisateurs. C’est là que les scripts d’automatisation entrent en jeu. Le script fourni est adapté aux environnements macOS et automatise le processus d’identification et de signalement des comptes d’utilisateurs inactifs. Il aide les professionnels de l’informatique à s’assurer que seuls les comptes actifs et nécessaires existent sur leurs systèmes.

Le script

#!/usr/bin/env bash
#
# Description: Alerts when there is an inactive/unused account that has not logged in for the specified number of days.
#
# Preset Parameter: --daysInactive "90"
#   Alert if account has been inactive for x days.
#
# Preset Parameter: --showDisabled
#   Includes disabled accounts in alert and report.
#
# Preset Parameter: --multilineField "ReplaceMeWithNameOfYourMultilineField"
#   Name of an optional multiline custom field to save the results to.
#
# Preset Parameter: --wysiwygField "ReplaceMeWithNameOfYourWYSIWYGField"
#   Name of an optional WYSIWYG custom field to save the results to.
#
# Preset Parameter: --help
#   Displays some help text.
#
# 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).
#

# These are all our preset parameter defaults. You can set these = to something if you would prefer the script defaults to a certain parameter value.
_arg_daysInactive=
_arg_showDisabled="off"
_arg_multilineField=
_arg_wysiwygField=

# Help text function for when invalid input is encountered
print_help() {
  printf '\n\n%s\n\n' 'Usage: --daysInactive|-d <arg> [--multilineField|-m <arg>] [--wysiwygField|-w <arg>] [--showDisabled] [--help|-h]'
  printf '%s\n' 'Preset Parameter: --daysInactive "90"'
  printf '\t%s\n' "Alert if account has been inactive for x days."
  printf '%s\n' 'Preset Parameter: --showDisabled'
  printf '\t%s\n' "Includes disabled accounts in alert and report."
  printf '%s\n' 'Preset Parameter: --multilineField "ReplaceMeWithNameOfYourMultilineField"'
  printf '\t%s\n' "Name of an optional multiline custom field to save the results to."
  printf '%s\n' 'Preset Parameter: --wysiwygField "ReplaceMeWithNameOfYourWYSIWYGField"'
  printf '\t%s\n' "Name of an optional WYSIWYG custom field to save the results to."
  printf '\n%s\n' 'Preset Parameter: --help'
  printf '\t%s\n' "Displays this help menu."
}

# Determines whether or not help text is necessary and routes the output to stderr
die() {
  local _ret="${2:-1}"
  echo "$1" >&2
  test "${_PRINT_HELP:-no}" = yes && print_help >&2
  exit "${_ret}"
}

# Converts a string input into an HTML table format.
convertToHTMLTable() {
  local _arg_delimiter=" "
  local _arg_inputObject

  # Process command-line arguments for the function.
  while test $# -gt 0; do
    _key="$1"
    case "$_key" in
    --delimiter | -d)
      test $# -lt 2 && echo "[Error] Missing value for the optional argument" >&2 && return 1
      _arg_delimiter=$2
      shift
      ;;
    --*)
      echo "[Error] Got an unexpected argument" >&2
      return 1
      ;;
    *)
      _arg_inputObject=$1
      ;;
    esac
    shift
  done

  # Handles missing input by checking stdin or returning an error.
  if [[ -z $_arg_inputObject ]]; then
    if [ -p /dev/stdin ]; then
      _arg_inputObject=$(cat)
    else
      echo "[Error] Missing input object to convert to table" >&2
      return 1
    fi
  fi

  local htmlTable="<table>\n"
  htmlTable+=$(printf '%b' "$_arg_inputObject" | head -n1 | awk -F "$_arg_delimiter" '{
    printf "<tr>"
    for (i=1; i<=NF; i+=1)
      { printf "<th>"$i"</th>" }
    printf "</tr>"
    }')
  htmlTable+="\n"
  htmlTable+=$(printf '%b' "$_arg_inputObject" | tail -n +2 | awk -F "$_arg_delimiter" '{
    printf "<tr>"
    for (i=1; i<=NF; i+=1)
      { printf "<td>"$i"</td>" }
    print "</tr>"
    }')
  htmlTable+="\n</table>"

  printf '%b' "$htmlTable" '\n'
}

# Parses command-line arguments and sets script variables accordingly.
parse_commandline() {
  while test $# -gt 0; do
    _key="$1"
    case "$_key" in
    --daysInactive | --daysinactive | --days | -d)
      test $# -lt 2 && die "Missing value for the required argument '$_key'." 1
      _arg_daysInactive=$2
      shift
      ;;
    --daysInactive=*)
      _arg_daysInactive="${_key##--daysInactive=}"
      ;;
    --multilineField | --multilinefield | --multiline | -m)
      test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
      _arg_multilineField=$2
      shift
      ;;
    --multilineField=*)
      _arg_multilineField="${_key##--multilineField=}"
      ;;
    --wysiwygField | --wysiwygfield | --wysiwyg | -w)
      test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
      _arg_wysiwygField=$2
      shift
      ;;
    --wysiwygField=*)
      _arg_wysiwygField="${_key##--wysiwygField=}"
      ;;
    --showDisabled | --showdisabled)
      _arg_showDisabled="on"
      ;;
    --help | -h)
      _PRINT_HELP=yes die 0
      ;;
    *)
      _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
      ;;
    esac
    shift
  done
}

# Parses the command-line arguments passed to the script.
parse_commandline "$@"

# If dynamic script variables are used replace the commandline arguments with them.
if [[ -n  $daysInactive ]]; then
  _arg_daysInactive="$daysInactive"
fi

if [[ -n $includeDisabled && $includeDisabled == "true" ]]; then
  _arg_showDisabled="on"
fi

if [[ -n $multilineCustomFieldName ]]; then
  _arg_multilineField="$multilineCustomFieldName"
fi

if [[ -n $wysiwygCustomFieldName ]]; then
  _arg_wysiwygField="$wysiwygCustomFieldName"
fi

# Check if _arg_daysInactive contains any non-digit characters or is less than zero.
# If any of these conditions are true, display the help text and terminate with an error.
if [[ -z $_arg_daysInactive || $_arg_daysInactive =~ [^0-9]+ || $_arg_daysInactive -lt 0 ]]; then
  _PRINT_HELP=yes die "FATAL ERROR: Days Inactive of '$_arg_daysInactive' is invalid! Days Inactive must be a positive number." 1
fi

# Check if both _arg_multilineField and _arg_wysiwygField are set and not empty.
if [[ -n "$_arg_multilineField" && -n "$_arg_wysiwygField" ]]; then
  # Convert both field names to uppercase to check for equality.
  multiline=$( echo "$_arg_multilineField" | tr '[:lower:]' '[:upper:]' )
  wysiwyg=$( echo "$_arg_wysiwygField" | tr '[:lower:]' '[:upper:]' )

  # If the converted names are the same, it means both fields cannot be identical.
  # If they are, terminate the script with an error.
  if [[ "$multiline" == "$wysiwyg" ]]; then
    _PRINT_HELP=no die 'FATAL ERROR: Multline Field and WYSIWYG Field cannot be the same name. https://ninjarmm.zendesk.com/hc/en-us/articles/360060920631-Custom-Fields-Configuration-Device-Role-Fields'
  fi
fi

# Retrieves the list of user accounts with UniqueIDs greater than 499 (typically these are all not service accounts) from the local user directory.
userAccounts=$(dscl . -list /Users UniqueID | awk '$2 > 499 {print $1}')

# Sets up a header string for the table that will display user account information.
header=$(printf '%s' "Username" ';' "Password Last Set" ';' "Last Logon" ';' "Enabled")

# Initializes an empty string to store information about relevant user accounts.
relevantAccounts=

# Iterates over each user account retrieved earlier.
for userAccount in $userAccounts; do
  # Extracts the last login information for that user, filtering out unnecessary lines and formatting.
  lastLogin=$(last -1 "$userAccount" | grep -v "wtmp" | grep "\S" | tr -s " " | cut -f3-6 -d " ")

  # Converts the last login date to seconds since the epoch, for easier date comparison.
  if [[ -n $lastLogin ]]; then
    lastLogin=$(date -j -f "%a %b %d %H:%M" "$lastLogin" +"%s")
  fi

  # Calculates the cutoff date in seconds since the epoch for inactivity comparison, based on the days inactive argument.
  if [[ $_arg_daysInactive -gt 0 ]]; then
    cutoffDate=$(date -v "-${_arg_daysInactive}d" "+%s")
  fi

  # Retrieves the timestamp when the password was last set for the user account and converts it to a readable format.
  passwordLastSet=$(dscl . -read "/Users/$userAccount" accountPolicyData | tail -n +2 | plutil -extract passwordLastSetTime xml1 -o - -- - | sed -n "s/<real>\([0-9]*\).*/\1/p")
  passwordLastSet=$(date -r "$passwordLastSet")

  # Checks if the user account is part of the group that defines disabled accounts, setting the 'enabled' variable accordingly.
  pwpolicy=$(dseditgroup -o checkmember -u "$userAccount" com.apple.access_disabled | grep "no $userAccount")
  authenticationAuthority=$(dscl . -read "/Users/$userAccount" AuthenticationAuthority | grep "DisabledUser")
  if [[ -n $pwpolicy && -z $authenticationAuthority ]]; then
    enabled="true"
  else
    enabled="false"
  fi

  # Checks if the account is inactive based on the last login date and cutoff date or if the account should be included regardless of its active status.
  if [[ $_arg_daysInactive == "0" || -z "$lastLogin" || $lastLogin -le $cutoffDate ]]; then
    # Formats the last login date or sets it to "Never" if the user has never logged in.
    if [[ -n $lastLogin ]]; then
      lastLogin=$(date -j -f "%s" "$lastLogin")
    else
      lastLogin="Never"
    fi

    # Skips adding disabled accounts to the output if they should not be shown.
    if [[ $_arg_showDisabled == "off" && $enabled == "false" ]]; then
      continue
    fi

    # Appends the account information to the 'relevantAccounts' string if it meets the criteria.
    relevantAccounts+=$(printf '%s' '\n' "$userAccount" ';' "$passwordLastSet" ';' "$lastLogin" ';' "$enabled")
    foundInactiveAccounts="true"
  fi
done

# Checks if there are any inactive accounts found.
if [[ $foundInactiveAccounts == "true" ]]; then
  # Formats a nice table for easier viewing
  tableView="$header"
  tableView+=$(printf '%s' '\n' "--------" ';' "-----------------" ';' "----------" ';' "-------")
  tableView+="$relevantAccounts"
  tableView=$(printf '%b' "$tableView" | sed 's/$/\n/' | column -s ';' -t)

  # Output to the activity log
  echo ""
  echo 'WARNING: Inactive accounts detected!'
  echo ""
  printf '%b' "$tableView"
  echo ""
else
  # If no inactive accounts were found, outputs a simple message.
  echo "No inactive accounts detected."
fi

# Checks if there is a multiline custom field set and if any inactive accounts have been found.
if [[ -n $_arg_multilineField && $foundInactiveAccounts == "true" ]]; then
  echo "" 
  echo "Attempting to set Custom Field '$_arg_multilineField'..."

  # Formats the relevantAccounts data for the multiline custom field.
  multilineValue=$(printf '%b' "$relevantAccounts" | grep "\S" | awk -F ";" '{ 
      print "Username: "$1
      print "Password Last Set: "$2
      print "Last Logon: "$3
      print "Enabled: "$4 
      print ""
  }')

  # Tries to set the multiline custom field using ninjarmm-cli and captures the output.
  if ! output=$(printf '%b' "$multilineValue" | /Applications/NinjaRMMAgent/programdata/ninjarmm-cli set --stdin "$_arg_multilineField" 2>&1); then
    echo "[Error] $output" >&2
    EXITCODE=1
  else
    echo "Successfully set Custom Field '$_arg_multilineField'!"
  fi
fi

# Checks if there is a WYSIWYG custom field set and if any inactive accounts have been found.
if [[ -n $_arg_wysiwygField && $foundInactiveAccounts == "true" ]]; then
  echo ""
  echo "Attempting to set Custom Field '$_arg_wysiwygField'..."

  # Initializes an HTML formatted string with headers and account details.
  htmlObject="$header"
  htmlObject+="$relevantAccounts"

  # Converts the text data to an HTML table format.
  htmlObject=$(convertToHTMLTable --delimiter ';' "$htmlObject")

  # Tries to set the WYSIWYG custom field using ninjarmm-cli and captures the output.
  if ! output=$(echo "$htmlObject" | /Applications/NinjaRMMAgent/programdata/ninjarmm-cli set --stdin "$_arg_wysiwygField" 2>&1); then
    echo "[Error] $output" >&2
    EXITCODE=1
  else
    echo "Successfully set Custom Field '$_arg_wysiwygField'!"
  fi
fi

# Checks if an error code is set and exits the script with that code.
if [[ -n $EXITCODE ]]; then
  exit "$EXITCODE"
fi

 

Description détaillée

Découvrons le fonctionnement de ce script étape par étape.

Paramètres prédéfinis

Le script commence par définir plusieurs paramètres prédéfinis :

• daysInactive: Nombre de jours après lesquels un compte est considéré comme inactif. La valeur par défaut est de 90 jours.

• showDisabled: Inclut les comptes désactivés dans le rapport.

• multilineField: Spécifie un champ personnalisé multiligne pour enregistrer les résultats.

• wysiwygField: Spécifie un champ personnalisé WYSIWYG pour enregistrer les résultats.

• help: Affiche le texte d’aide.

Fonction d’aide

La fonction print_help fournit des instructions d’utilisation et des descriptions pour chaque paramètre, afin que les utilisateurs puissent utiliser correctement le script.

Analyse des arguments de la ligne de commande

Le script analyse les arguments de la ligne de commande à l’aide de la fonction parse_commandline. Cette fonction définit les variables de script appropriées en fonction des choix de l’utilisateur. Il comprend également des validations pour s’assurer que les arguments fournis sont corrects.

Contrôle de l’inactivité

La fonctionnalité de base consiste à vérifier l’inactivité des comptes d’utilisateurs :

1. Récupération des comptes d’utilisateurs: Il recherche les comptes d’utilisateurs dont l’UniqueID est supérieur à 499 (à l’exclusion des comptes de service).
2. Dernière heure de connexion et de définition du mot de passe: Pour chaque compte, il récupère l’heure de la dernière connexion et le moment où le mot de passe a été défini pour la dernière fois.
3. Comparaison de l’inactivité: Il compare l’heure de la dernière connexion à la date du jour moins la période d’inactivité spécifiée (par exemple, 90 jours). Les comptes qui ne se sont pas connectés pendant cette période sont marqués comme inactifs.

Génération de rapports

Le script génère un rapport détaillé des comptes inactifs :

• Format de tableau: Il crée un format de tableau pour faciliter la visualisation, affichant le nom d’utilisateur, l’heure de la dernière définition du mot de passe, l’heure de la dernière connexion et l’activation ou non du compte.

• Champs personnalisés: S’il est spécifié, il enregistre les résultats dans des champs personnalisés à l’aide de l’outil d’interface en ligne de commande de NinjaRMM.

Gestion des erreurs

Le script comprend un traitement perfofmant des erreurs qui permet de gérer les entrées non valides et les défaillances opérationnelles de manière élégante, garantissant ainsi la fiabilité dans diverses situations.

Cas d’utilisation potentiels

Imaginez un professionnel de l’informatique qui gère le parc informatique macOS d’une entreprise. Régulièrement, il doit vérifier les comptes des utilisateurs pour garantir la conformité et la sécurité. En exécutant ce script chaque semaine, il peut automatiquement identifier et signaler les comptes inactifs. Par exemple, si un employé quitte l’entreprise, son compte peut être inactif pendant une longue période. Le script alerte le professionnel de l’informatique, qui examine et désactive ou supprime le compte, afin de maintenir un répertoire d’utilisateurs actualisé et sécurisé.

Comparaison entre l’audit manuel et l’automatisation des scripts

Audit manuel :

• Prend du temps et est sujet à des erreurs.

• Nécessite des efforts constants et de la diligence.

Automatisation des scripts :

• Efficace et précis.

• Elle fournit des alertes en temps utile, réduisant ainsi le risque de négliger des comptes inactifs.

Autres outils

Alors que d’autres outils et scripts peuvent offrir des fonctionnalités similaires, l’intégration de ce script avec les champs personnalisés de NinjaOne et sa conception spécifique pour les environnements macOS le distinguent. Il fournit une solution sur mesure pour les administrateurs macOS, en s’appuyant sur des outils natifs tels que dscl et dseditgroup.

FAQ

1) Que fait le script si aucun compte inactif n’est trouvé ?

Si aucun compte inactif n’est trouvé, le script affiche un simple message : « No inactive accounts detected. »

2) Le script peut-il inclure des comptes désactivés dans le rapport ?

Oui, en utilisant le paramètre –showDisabled, le script inclut les comptes désactivés dans le rapport.

3) Comment le script gère-t-il les erreurs ?

Le script comprend un traitement complet des erreurs pour gérer les entrées non valides et les défaillances opérationnelles, ce qui garantit un fonctionnement fiable.

Implications

L’identification des comptes inactifs permet d’atténuer les risques de sécurité. En gérant ces comptes de manière proactive, les entreprises peuvent empêcher les accès non autorisés et s’assurer que leurs répertoires d’utilisateurs restent exacts et sécurisés. L’utilisation régulière de ce script favorise le respect des politiques de sécurité et réduit la surface d’attaque.

Recommandations

Lors de l’utilisation de ce script :

• Planifiez des exécutions régulières (hebdomadaires, par exemple) pour maintenir à jour les rapports d’activité des utilisateurs.

• Combinez-les avec d’autres mesures de sécurité, telles que le changement régulier de mot de passe et l’examen des comptes.

• Personnalisez la période d’inactivité en fonction des politiques et des exigences de l’entreprise.

Conclusion

NinjaOne fournit une plateforme performante pour la gestion informatique, et l’intégration de tels scripts renforce ses capacités. Ce script, conçu pour signaler les comptes d’utilisateurs inactifs sur macOS, illustre la manière dont l’automatisation peut améliorer la sécurité et l’efficacité. En exploitant les champs personnalisés et les capacités d’automatisation de NinjaOne, les professionnels de l’informatique peuvent optimiser leurs flux de travail et se concentrer sur des tâches plus stratégiques.