Come utilizzare uno script shell per inviare avvisi sugli account utente inattivi su macOS

La gestione degli account utente è un aspetto cruciale dell’amministrazione IT. Garantire che gli account inattivi o non utilizzati vengano segnalati e gestiti tempestivamente è fondamentale per mantenere la sicurezza e l’efficienza. In questo articolo analizzeremo uno script shell progettato per avvisare gli amministratori degli account utente inattivi su macOS. Questo script per tenere traccia degli account utente inattivi su macOS è uno strumento essenziale per i professionisti IT e i fornitori di servizi gestiti (MSP) che intendono migliorare la propria posizione di sicurezza e semplificare la gestione degli account.

Background

Gli account inattivi comportano rischi significativi per la sicurezza. Possono essere sfruttati da soggetti malintenzionati per ottenere un accesso non autorizzato ai sistemi. Nelle grandi organizzazioni, tenere traccia in modo manuale dell’attività degli utenti è poco pratico. È qui che entrano in gioco gli script di automazione. Lo script fornito è adattato agli ambienti macOS e automatizza il processo di identificazione e segnalazione degli account utente inattivi su macOS. Aiuta i professionisti IT a garantire che sui loro sistemi siano presenti solo gli account attivi e necessari.

Lo script per tenere traccia degli account utente inattivi su macOS

#!/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

 

Analisi dettagliata

Analizziamo passo dopo passo il funzionamento di questo script per tenere traccia degli account utente inattivi su macOS.

Parametri preimpostati

Lo script per tenere traccia degli account utente inattivi su macOS inizia con la definizione di alcuni parametri preimpostati:

• daysInactive: Il numero di giorni dopo i quali un account viene considerato inattivo. L’impostazione predefinita è di 90 giorni.

• showDisabled: Include gli account disabilitati nel report.

• multilineField: Specifica un campo personalizzato multilinea per salvare i risultati.

• wysiwygField: Specifica un campo personalizzato WYSIWYG per salvare i risultati.

• help: Visualizza il testo di aiuto.

Funzione di aiuto

La funzione print_help fornisce istruzioni d’uso e descrizioni per ogni parametro, assicurando che gli utenti possano utilizzare correttamente lo script per tenere traccia degli account utente inattivi su macOS.

Parsing degli argomenti della riga di comando

Lo script per tenere traccia degli account utente inattivi su macOS analizza gli argomenti della riga di comando utilizzando la funzione parse_commandline. Questa funzione imposta le variabili di script appropriate in base all’input dell’utente. Include anche delle convalide per garantire che gli argomenti forniti siano corretti.

Controllo dell’inattività

La funzionalità principale consiste nel verificare l’inattività degli account utente:

1. Recupero degli account utente: Recupera gli account utente con UniqueID superiori a 499 (esclusi gli account di servizio).
2. Orario dell’ultimo accesso e della più recente impostazione della password: Per ogni account, recupera l’ora dell’ultimo accesso e il timestamp dell’ultima impostazione della password.
3. Confronto sull’inattività: Confronta l’ora dell’ultimo accesso con la data corrente sottraendo il periodo di inattività specificato (per esempio, 90 giorni). Gli account che non hanno effettuato l’accesso entro questo periodo vengono segnalati come inattivi.

Generazione del report

Lo script genera un report dettagliato sugli account utente inattivi su macOS:

• Formato della tabella: Crea un formato in tabella per facilitare la visualizzazione, mostrando il nome utente, l’orario dell’ultima password impostata, l’orario dell’ultimo accesso e se l’account è abilitato.

• Campi personalizzati: Se specificato, salva i risultati nei campi personalizzati utilizzando lo strumento NinjaRMM CLI.

Gestione degli errori

Lo script per tenere traccia degli account utente inattivi su macOS include una solida gestione degli errori per gestire gli input non validi e i guasti operativi, garantendo affidabilità in vari scenari.

Casi d’uso potenziali

Immagina un professionista IT che gestisce il parco dispositivi macOS di un’azienda. Deve verificare regolarmente gli account degli utenti per garantire conformità e sicurezza. Eseguendo questo script settimanalmente, può identificare e segnalare automaticamente gli account utente inattivi su macOS. Per esempio, se un dipendente lascia l’azienda, il suo account potrebbe rimanere inattivo per un lungo periodo. Lo script avvisa il professionista IT, che esamina e disabilita o rimuove l’account, mantenendo una directory utenti pulita e sicura.

Audit manuale e automazione tramite script a confronto

Audit manuale:

• Richiede tempo ed è soggetto a errori.

• Richiede uno sforzo e un impegno costanti.

Automazione tramite script:

• Efficiente e precisa.

• Fornisce avvisi tempestivi, riducendo il rischio di non notare gli account utente inattivi su macOS.

Altri strumenti

Anche se altri strumenti e script potrebbero offrire funzionalità simili, l’integrazione di questo script per tenere traccia degli account utente inattivi su macOS con i campi personalizzati di NinjaOne e il suo design specifico per gli ambienti macOS lo rendono una scelta privilegiata. Offre una soluzione su misura per gli amministratori macOS, sfruttando strumenti nativi come dscl e dseditgroup.

Domande frequenti

1) Cosa fa lo script se non vengono trovati account inattivi?

Se non vengono trovati account inattivi, lo script per tenere traccia degli account utente inattivi su macOS genera un semplice messaggio: “Non sono stati rilevati account inattivi”.

2) Lo script può includere gli account disabilitati nel report?

Sì, utilizzando il parametro –showDisabled, lo script include gli account disabilitati nel report.

3) Come gestisce gli errori lo script?

Lo script per tenere traccia degli account utente inattivi su macOS include una gestione completa degli errori per gestire gli input non validi e i guasti operativi, garantendo un funzionamento affidabile.

Implicazioni

L’identificazione degli account utente inattivi su macOS aiuta a ridurre i rischi per la sicurezza. Gestendo in modo proattivo questi account, le organizzazioni possono prevenire gli accessi non autorizzati e garantire che le loro directory di utenti rimangano accurate e sicure. L’uso regolare di questo script per tenere traccia degli account utente inattivi su macOS permette di ottenere conformità ai criteri di sicurezza e riduce la superficie di attacco.

Raccomandazioni

Durante l’utilizzo di questo script:

• Programma esecuzioni regolari (per esempio, settimanali) per mantenere aggiornati i report sulle attività degli utenti.

• Usa lo script per tenere traccia degli account utente inattivi su macOS insieme ad altre misure di sicurezza, come la modifica regolare delle password e il controllo degli account.

• Personalizza il periodo di inattività in base ai criteri e ai requisiti dell’organizzazione.

Considerazioni finali

NinjaOne offre una solida piattaforma per la gestione dell’IT e la possibilità di integrazione di script come questo per tenere traccia degli account utente inattivi su macOS ne potenzia le capacità. Questo script, progettato per segnalare gli account utente inattivi su macOS, è un esempio di come l’automazione possa migliorare la sicurezza e l’efficienza. Sfruttando i campi personalizzati e le funzionalità di automazione di NinjaOne, i professionisti IT possono snellire i loro flussi di lavoro e concentrarsi su attività più strategiche.