├── com.example.DeleteUsers.plist
├── 555.DeleteUsers
├── README.md
└── LICENSE
/com.example.DeleteUsers.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Label
6 | com.example.DeleteUsers
7 |
8 | ProgramArguments
9 |
10 | /usr/local/bin/DeleteUsers.sh
11 |
12 |
13 | StartCalendarInterval
14 |
15 | Hour
16 | 3
17 | Minute
18 | 0
19 |
20 |
21 | StandardOutPath
22 | /var/log/DeleteUsers.log
23 | StandardErrorPath
24 | //var/log/DeleteUsers.err
25 |
26 | RunAtLoad
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/555.DeleteUsers:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # Define log file
4 | LOGFILE="/var/log/DeleteUsers.log"
5 |
6 | # Function to log messages
7 | log() {
8 | echo "$(date '+%m-%d-%Y %H:%M:%S') - $1" | tee -a $LOGFILE
9 | }
10 |
11 | # Start logging
12 | log "-------- "
13 | log "Script started."
14 | log " "
15 |
16 | # Capturing uniqname of user currently logging in to system
17 | loggedInUser=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ { print $3 }')
18 |
19 | # Checking usage of each disk slice
20 | df -H | grep -vE '^Filesystem|tmpfs|cdrom|devfs|map' | awk '{ print $5 " " $9 }' | while read output;
21 | do
22 | echo $output
23 | usep=$(echo $output | awk '{ print $1}' | cut -d'%' -f1 )
24 | # Amount of disk space in use to trigger script
25 | limit=90
26 | partition=$(echo $output | awk '{ print $2 }' )
27 |
28 | # Confirming that the user Data slice is triggering usage
29 | if [ $usep -ge $limit ] && [ $partition = '/System/Volumes/Data' ] ; then
30 |
31 | # Create the whitelist of users to avoid deleting here
32 | exclusion_pattern="admin|.localized|Shared|root|loginwindow" ### <-- whitelist users here
33 |
34 | # If a user is logged in, add `loggedInUser` to the exclusion pattern
35 | if [ -n "$loggedInUser" ]; then
36 | exclusion_pattern="${exclusion_pattern}|${loggedInUser}"
37 | fi
38 |
39 | # Log the detected logged-in user (or indicate none)
40 | if [ -n "$loggedInUser" ]; then
41 | log "Logged in user detected: $loggedInUser"
42 | else
43 | log "No user is currently logged in."
44 | fi
45 |
46 | # Log users to be deleted
47 | log "Users to be deleted:"
48 | log " "
49 |
50 | # Email notification
51 | deletedUsers=""
52 |
53 | # Checking for protected users
54 | # Add additional accounts to be saved below
55 | for home in $(ls /Users | grep -v -E "$exclusion_pattern"); do
56 |
57 | log "Processing user: $home"
58 |
59 | # Deleting non-protected users
60 | /usr/local/bin/jamf deleteAccount -username $home -deleteHomeDirectory
61 |
62 | # Verify user removal
63 | if [ $? -eq 0 ]; then
64 | log "Deleted user: $home"
65 | deletedUsers="$deletedUsers $home"
66 |
67 | # Check and remove home directory
68 | if [ -d "/Users/$home" ]; then
69 | rm -rf "/Users/$home"
70 | log "Deleted home directory for: $home"
71 | fi
72 | else
73 | log "Failed to delete user: $home"
74 | fi
75 | done
76 |
77 | # End logging
78 | log " "
79 | log "Process complete."
80 | log " "
81 |
82 | # Refreshing the user list
83 | sudo killall opendirectoryd
84 |
85 | # Sending email notification of activity to designated admin
86 | ## Change sender and recipients below
87 |
88 | echo "To: admin@example.com\ncc: other_admin@example.com\nSubject: Disk usage $usep% on $(hostname)\nLocal storage has exceeded $limit%. The following users were automatically deleted: $deletedUsers" | sendmail -f admin@example.com -t admin@example.com other_admin@example.com fi
89 | done
90 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 | # DeleteUsers
3 |
4 | DeleteUsers is available as both a script and an application that will delete user account data off of a macOS machine, excluding any pre-defined users.
5 |
6 | ## Why?
7 |
8 | Managed lab machines have a tendency to run low on space, as users will occasionally leave large amounts of content behind. I put this application together to help streamline the deletion process. Having seen several requests for how to do something like this in the MacAdmins Slack, I decided to make my version of this tool public as sample code. Feel free to tinker with it and modify it to fit your needs.
9 |
10 | This application can be manually run at any time to delete user accounts, while the script can be used to automate the process.
11 |
12 | ### Disclaimer:
13 |
14 | The following code is provide as a community resource and as sample code for testing purposes, and is licensed under the terms of Apache license 2.0. No warranty is expressed or implied. Any results from the execution of the following code are 100% the responsiblity of the downloader and executor.
15 |
16 | ## Installation
17 |
18 | The application can be stored anywhere on the machine, but it is recommended that it be kept in a location only accessible by those with admin access.
19 |
20 | The script should be placed in `/usr/local/bin` by default, as is it managed with the `launchd` utility. The script is also dependant on your systems being managed with Jamf, as it calls `/usr/local/bin/jamf` to perform its work. (This is the only tool I have found to work with Apple's secure token and volume ownership processes.)
21 |
22 | **VERY IMPORTANT!** Make sure you edit the script / application BEFORE first run!
23 |
24 | DeleteUsers - as the name implies - will delete ALL user accounts on the machine, with the exceptions of the currently logged in user, and those accounts whitelisted within the script. If you have any accounts on the machine that you want to keep, make sure to whitelist them before the first run!
25 |
26 | By default, the line in the script that whitelists those accounts is:
27 |
28 | `exclusion_pattern="admin|.localized|Shared|root|loginwindow" ### <-- whitelist users here`
29 |
30 | You need to add your admin / testing / other accounts of value to this line by adding additional `account_name` entries to that line with a `|` separating them.
31 |
32 | Changes can be made within the executable by editing `/DeleteUsers.app/Contents/Resources/script`.
33 |
34 | ## Usage - application:
35 |
36 | When you launch the application, you will be prompted for admin rights:
37 |
38 | 
39 |
40 | From there, you will get a pop-up window reminding you to make sure your admin accounts and other important users are whitelisted:
41 |
42 | 
43 |
44 |
45 | Next, the main app window will appear (the "Details" window is closed on first launch, but can be toggled open to see a list of deleted users):
46 |
47 | 
48 |
49 | Once the application finds a user to delete, it will prompt you again for permission to admin your computer:
50 |
51 | 
52 |
53 | After all users have been deleted, the script will finish, prompting you to quit the application:
54 |
55 | 
56 |
57 | -----
58 |
59 | ## Usage - script:
60 |
61 | The script is managed via `launchd`, so there is some setup involved to get it running. After copying the script to its preferred location (`/usr/local/bin` is a good location) and confirming the whitelist in the script, a .plist file needs to be created to schedule the script's execution. In the example below, the .plist is located in `/Library/LaunchDaemons` and is currently configured to run daily at 3 am:
62 |
63 | ```
64 |
65 |
66 |
67 |
68 | Label
69 | com.example.DeleteUsers
70 |
71 | ProgramArguments
72 |
73 | /usr/local/bin/DeleteUsers.sh
74 |
75 |
76 | StartCalendarInterval
77 |
78 | Hour
79 | 3
80 | Minute
81 | 0
82 |
83 |
84 | StandardOutPath
85 | /var/log/DeleteUsers.log
86 | StandardErrorPath
87 | //var/log/DeleteUsers.err
88 |
89 | RunAtLoad
90 |
91 |
92 |
93 | ```
94 |
95 | Once the .plist is created, the script needs to be actived, which is done by issuing the following command:
96 |
97 | `sudo launchctl start /usr/local/bin/DeleteUsers.sh`
98 |
99 | If changes need to be made to the script after it has started, its launchd process must be stopped:
100 |
101 | `sudo launchctl stop /usr/local/bin/DeleteUsers.sh`
102 |
103 | After that, changes can be made, and the script re-activated with the previous `launchctl start` command.
104 |
105 | ---
106 |
107 | The `DeleteUsers.sh` script will delete all non-whitelisted user accounts with no interaction needed once a drive space usage percentage is reached. That percentage is defined in the script under the `limit` variable.
108 |
109 | If the script executes and deletes users, it will send an email through `sendmail` on the local machine. Subject, recipients, and content are defined in the following line:
110 |
111 | `echo "To: admin@example.com\ncc: other_admin@example.com\nSubject: Disk usage $usep% on $(hostname)\nLocal storage has exceeded $limit%. The following users were automatically deleted: $deletedUsers" | sendmail -f admin@example.com -t admin@example.com other_admin@example.com`
112 |
113 | ### Fiddly bits
114 |
115 | This is a very blunt object of a script. Once you give it permission to run, accounts WILL be deleted, and will continue to be deleted until /Users has been scanned completely. Please be sure there is no data that is needed to be saved from those accounts, because it won't be there once you set the script loose.
116 |
117 | Log files can be found in `/var/log/DeleteUsers.log` for actions performed by the script, and in `/var/log/DeleteUsersGUI.log` for actions performed by the application.
118 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------