|
| 1 | +# What's New In XCreds # |
| 2 | + |
| 3 | +## XCreds 3.1 ## |
| 4 | + |
| 5 | +### Active Directory Login ### |
| 6 | +New username and password window allows logging in with local user or Active Directory (if ADDomain key is defined). |
| 7 | + |
| 8 | +### New Username and Password Window ### |
| 9 | +We no longer use the macOS login window and use the new XCreds username/password window. This allows for faster switching and Active Directory login. |
| 10 | + |
| 11 | +### Admin Group ### |
| 12 | + |
| 13 | +If group membership is returned in the "groups" claim and matches the group defined in the "CreateAdminIfGroupMember" preference, the user will be created as admin. |
| 14 | + |
| 15 | +### Override Preference Script ### |
| 16 | + |
| 17 | +Most preferences can now be overwritten by specifying a script at the path defined by "settingsOverrideScriptPath". This script, if it exists, owned by root, and has permissions 755 (writable only by root, readable and executable by all) must return a valid plist that defines the key/value pairs to override in preferences. This allows for basing preferences based on the local state of the machine. It is important for the "localAdminUserName" and "localAdminPassword" keys. See Reset Keychain for more information on this. The overide script can also be used for querying the local state and setting preferences. For example, to randomly set the background image, a sample script "settingsOverrideScriptPath" defines a script: |
| 18 | + |
| 19 | + |
| 20 | + !/bin/sh |
| 21 | + dir="/System/Library/Desktop Pictures" |
| 22 | + desktoppicture=`/bin/ls -1 "$dir"/*.heic | sort --random-sort | head -1` |
| 23 | + |
| 24 | + cat /usr/local/xcreds/override.plist|sed "s|DESKTOPPICTUREPATH|${desktoppicture}|g" |
| 25 | + |
| 26 | +The plist would defined as: |
| 27 | + |
| 28 | + <?xml version="1.0" encoding="UTF-8"?> |
| 29 | + <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> |
| 30 | + <plist version="1.0"> |
| 31 | + <dict> |
| 32 | + <key>loginWindowBackgroundImageURL</key> |
| 33 | + <string>file://DESKTOPPICTUREPATH</string> |
| 34 | + </dict> |
| 35 | + </plist> |
| 36 | + |
| 37 | + |
| 38 | +### Reset Keychain ## |
| 39 | +In prior versions of XCreds, the ability to reset the keychain if the user forgets their local password would fail due to the lack of a admin user with a secure token. This would cause the "PasswordOverwriteSilent" to fail. |
| 40 | + |
| 41 | +The "settingsOverrideScriptPath" (see above) can return the admin username and password of an admin account that has a secure token. This admin user is then used to reset the user's keychain if they forgot their local password. This can either be done with user prompting or silently. |
| 42 | + |
| 43 | +The script can find those keys via curl, in system keychain, or in a LAPS file and return the values inside the plist that is returned. This gives flexablity in determining the security required for the local admin username and password. |
| 44 | + |
| 45 | +Note that XCreds assumes an admin user with a secure token already exists on the machine and XCreds does not create or manage this user. If you manage local admin via a LAPS system, you can return the password from the local password file. |
| 46 | + |
| 47 | +An example of an override script to return username and password are as follows: |
| 48 | + |
| 49 | +Override Script: |
| 50 | + |
| 51 | + ` !/bin/sh` |
| 52 | +` dir="/System/Library/Desktop Pictures"` |
| 53 | +` desktoppicture=/bin/ls -1 "$dir"/*.heic | sort --random-sort | head -1` |
| 54 | +` ` |
| 55 | +` #this is provided as an example. DO NOT KEEP ADMIN CREDENTIALS ON DISK! Use curl or other method for getting them temporarily.` |
| 56 | +` admin_username="tcadmin"` |
| 57 | +` admin_password="twocanoes"` |
| 58 | +` ` |
| 59 | +` cat /usr/local/xcreds/override.plist | sed "s|LOCALADMINUSERNAME|${admin_username}|g" | sed "s|LOCALADMINPASSWORD|${admin_password}|g" ` |
| 60 | + |
| 61 | +plist: |
| 62 | + |
| 63 | + `<?xml version="1.0" encoding="UTF-8"?>` |
| 64 | +` <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">` |
| 65 | +` <plist version="1.0">` |
| 66 | +` <dict>` |
| 67 | +` <key>localAdminUserName</key>` |
| 68 | +` <string>LOCALADMINUSERNAME</string>` |
| 69 | +` <key>localAdminPassword</key>` |
| 70 | +` <string>LOCALADMINPASSWORD</string>` |
| 71 | +` </dict>` |
| 72 | +` </plist>` |
| 73 | + |
| 74 | + |
| 75 | +## New Keys |
| 76 | + |
| 77 | +**ADDomain** |
| 78 | + |
| 79 | +The desired AD domain |
| 80 | + |
| 81 | +**CreateAdminIfGroupMember** |
| 82 | + |
| 83 | +List of groups that should have its members created as local administrators. Set as an Array of Strings of the group name. |
| 84 | + |
| 85 | +**shouldSwitchToLoginWindowWhenLocked** |
| 86 | + |
| 87 | +When set to true and the user locks the current session, XCreds will tell the system to switch to Login Window. The current session will stay active but the user will login with the XCreds Login Window to resume the session. |
| 88 | + |
| 89 | +**settingsOverrideScriptPath** |
| 90 | + |
| 91 | +Script to override defaults. Must return valid property list with specified defaults. Script must exist at path, be owned by root and only writable by root. |
| 92 | + |
| 93 | +**localAdminUserName** |
| 94 | + |
| 95 | +Username of local admin user. DO NOT SET THIS IN PREFERENCES. It is recommended to set this with the settingsOverrideScriptPath script. This user is used to reset the keychain if the user forgets their local password and to setup a secure token for newly created users. |
| 96 | + |
| 97 | +**localAdminPassword** |
| 98 | + |
| 99 | +Password of local admin user. DO NOT SET THIS IN PREFERENCES. It is recommended to set this with the settingsOverrideScriptPath script. This user is used to reset the keychain if the user forgets their local password and to setup a secure token for newly created users. |
| 100 | + |
| 101 | +**shouldFindPasswordElement** |
| 102 | + |
| 103 | +Selects the password element field in the web page by finding a form element that has bullets (input is password) |
| 104 | + |
| 105 | +**shouldShowCloudLoginByDefault** |
| 106 | + |
| 107 | +Determine if the mac login window or the cloud login window is shown by default |
| 108 | + |
| 109 | +**shouldShowMacLoginButton** |
| 110 | + |
| 111 | +Show the Mac Login Window button in XCreds Login |
| 112 | + |
| 113 | + |
| 114 | +## Version 3.0 Build 3607 ## |
| 115 | + |
| 116 | +Released 2023-04-19 |
| 117 | + |
| 118 | +- Updated license |
| 119 | +- Fixed typo |
| 120 | +- Fixed issue with crash if time is too far off |
| 121 | +- Fixed regression for password change not capturing new password on Azure |
| 122 | +- Added trial license |
| 123 | +- Version 2.4 |
| 124 | +- Added 802.1x support; added support for pref key for finding password based on type=password |
| 125 | +- Fixed changing wifi not dismissing dialog |
| 126 | +- Fixed issue with autorefresh |
| 127 | +- Added frontmost when prompting for keychain password |
| 128 | +- Fixed crashing issue due to null refreshview outlet |
| 129 | +- Fixed names and links in manifest |
| 130 | +- Tweaked text for user space refresh token window and added pref to show or hide |
| 131 | +- Updated sample config |
| 132 | +- Fixed focus issue |
| 133 | +- Fixed login window size and background image |
| 134 | +- Added in login window height/width min value of 100 |
| 135 | +- Added key for customizing return to XCreds; added preference and ability to automatically refresh login window |
| 136 | +- Updated language on keychain option and added pref in manifest |
| 137 | +- Added remove keychain option |
| 138 | + |
| 139 | +## Version 2.3 |
| 140 | +- Added more logging for id token |
| 141 | +- Removed progress screen overlay because it was hiding filevault |
| 142 | +- Added sub as local user account if other methods not available; added some additional logging |
| 143 | +- Removed test time |
| 144 | +- Fixed edge case when not showing xcreds login when logging out |
| 145 | +- Fixed shouldShowCloudLoginByDefault not working |
| 146 | +- Fixed timer issue |
| 147 | +- Removed show prefs menu |
| 148 | +- Implemented PasswordOverwriteSilent |
| 149 | +- Implemented KeychainReset |
| 150 | +- Added credit to script |
| 151 | +- Added startup script |
| 152 | +- Username hint was not being set |
| 153 | +- Renamed mapped prefs with a prefix |
| 154 | +- Changed case of keys |
| 155 | +- Made keys lowercase for mappings |
| 156 | +- Added new key for OIDC mapping |
| 157 | + |
| 158 | +## Version 2.2 |
| 159 | +- Added mappings for user info |
| 160 | + |
| 161 | +## Version 2.1 |
| 162 | +- Initial release |
0 commit comments