{"0": { "doc": "Welcome", "title": "Welcome to SamuraiSafe", "content": "SamuraiSafe is a password manager for macOS and iOS. It stores your passwords and other private information securely, generates unique passwords for each website or service, and synchronises across your devices. It allows you to easily login to websites and mobile apps without sharing passwords. Simple and Secure . | Highly secure yet easy to use, supports password security best practice. | . Strong Security . | Your private key is never stored or transmitted anywhere, | AES-256 encryption with secure hash (HMAC) to detect tampering or corruption, | Automatic clipboard clear and safe locking. | Automatic password safe backup. | . Generate & Audit Passwords . | Generate strong passwords (random characters or random words), | Password strength is shown for all passwords, | Filter based upon password age or password strength, locate shared passwords. | . Easy To Use . | Password AutoFill, Touch ID and Face ID, | Drag and drop username/password/url or use cut/paste, | Choice of web browser, split view (iPad), | Complete documentation. | . Sync to Multiple Devices . | iCloud sync between iPhone/iPad/Mac, | iTunes sync to a iPhone/iPad. | . Organise Passwords . | Store any textual information: credit card numbers, pin codes, account numbers, | Each entry may have an arbitrary length secure note and up to 20 custom fields, | Create multiple password safes, | Create groupings, | Maintain a history of previous passwords. | . Free . | SamuraiSafe is totally free to use on both MacOS and iOS. | Everyone should use a password manager. It shouldn’t be necessary to pay for a good one. | . Stable and Mature . | SamuraiSafe has been in the App Store since 2013. | . ", "url": "/assets/ios-man/en/0intro.html#welcome-to-samuraisafe", "relUrl": "/0intro.html#welcome-to-samuraisafe" },"1": { "doc": "Welcome", "title": "Welcome", "content": " ", "url": "/assets/ios-man/en/0intro.html", "relUrl": "/0intro.html" },"2": { "doc": "Safes", "title": "Safes", "content": "Password Entries are stored inside Password Safes (files). ", "url": "/assets/ios-man/en/1_safes.html", "relUrl": "/1_safes.html" },"3": { "doc": "Creating and Maintaining Password Safes", "title": "Creating and Maintaining Password Safes", "content": "You can create safes with either the macOS or iOS SamuraiSafe app. You can synchronise safes with your iPhone or iPad using iCloud or manually using iTunes. To create a safe on iOS, touch Edit, then click the text New local safe next to the green + sign (or New iCloud safe if iCloud is enabled) and enter your new safe name. After hitting Enter, you need to enter your safe password. This password is not recoverable, and neither is the information stored in the safe (without the password), so you must remember it. You can change the password at a later time, when the safe is open, by touching the and selecting Change safe password. Next you need to set up your groups. A default set is added to a new safe. Customise these as required. Group names can be changed, and empty groups can be deleted. You can then begin to create password entries. This is done by selecting a group, or All Groups, then touching the + sign, filling in the form, and then touching Done to save the entry. If using iCloud on macOS, and you wish to share an iCloud password safe with iOS, it is important the password safe resides in the private SamuraiSafe iCloud container, not the Finder iCloud Drive folder. This requires using the Move to iCloud menu item on macOS. The password safe should then appear on iOS devices on the same iCloud account. On macOS it will appear under the Open iCloud menu. To transfer a password safe using iTunes. See Transfer safe from MacOS to iOS without iCloud or iTunes. ", "url": "/assets/ios-man/en/1create.html", "relUrl": "/1create.html" },"4": { "doc": "Opening Your Safe", "title": "Opening Your Safe", "content": "The initial screen allows you to select the safe to open. Local safes may be copied onto your device using iTunes on macOS. To use iCloud, you need to be logged onto iCloud and have iCloud Drive enabled for SamuraiSafe. After you have selected a safe to open you will be presented with a login screen. You need to enter the safe password to proceed. If you have iCloud safes, you may see the safe name appear in grey without the > symbol - this indicates that the safe is downloading from iCloud. The name will go black and > symbol will appear when it is ready to be opened. If the name is in red, the safe is in conflict, and you will need to decide which version(s) to keep. Clicking Edit allows adding, renaming and deleting safes, and also moving safes from iCloud to/from the device. If you delete a safe, it is saved as a backup, so may be restored later if required. ", "url": "/assets/ios-man/en/2open.html", "relUrl": "/2open.html" },"5": { "doc": "Enabling Touch ID/Face ID", "title": "Enabling Touch ID/Face ID", "content": "Touch ID or Face ID allows credentials used to open a safe to be stored securely using the Secure Enclave of your iOS device. By authenticating with a fingerprint or faceprint, the credentials are retrieved and used to open your safe. Note however, that if a fingerprint/faceprint is added or deleted, or if the safe is renamed – the stored credentials will be invalidated. Similarly if the device passcode is turned off. Touch ID/Face ID safe credentials are stored only on the device and are otherwise unrecoverable. If you have enabled Face ID, the Face ID options illustrated below should appear when you attempt to open a safe. Similarly for Touch ID on an appropriate device. To enable Touch ID/Face ID for a safe, select Touch ID Login/Face ID Login and supply the safe password, then touch Done. If the password is correct credentials derived from the password will be saved securely for later use. Once Touch ID/Face ID is saved for a safe, SamuraiSafe will attempt to authenticate as soon as a safe is selected. If you wish to access the open safe options dialog, use a long press rather than a tap on the open safe screen. If you wish to disable Touch ID/Face ID for a safe, long press to access file options and disable Touch ID Login/Face ID Login to remove the stored safe password. You can disable Touch ID/Face ID for all safes (removing all associated Touch ID/Face ID safe passwords) by turning off Allow Touch ID Login/Allow Face ID Login in Settings. If a safe password is changed on another device, Touch ID will fail to open the safe and the stored password will be removed. Note also after unlocking the device with Touch ID/Face ID, or authenticating with Touch ID/Face ID in SamuraiSafe, for a short period (12 seconds) afterwards repeat Touch ID/Face ID validation isn’t required within SamuraiSafe. ", "url": "/assets/ios-man/en/3enable.html", "relUrl": "/3enable.html" },"6": { "doc": "Importing and Exporting", "title": "Importing and Exporting", "content": "The MacOS version of SamuraiSafe supports import/export of safes in the XML format used by the Java Password Safe App. You could use iCloud to share your safe(s) with MacOS, and then export/import from MacOS. If you have password file data in CSV format, you can find a CSV to XML conversion tool here: help.samarama.net . Note there are security implications to XML import/export as the plaintext may be stored permanently on your macOS system inadvertently. To ensure any XML files are removed securely use rm -P on the command line to overwrite files before deleting them. ", "url": "/assets/ios-man/en/3import.html", "relUrl": "/3import.html" },"7": { "doc": "Restoring a Safe from Backups", "title": "Restoring a Safe from Backups", "content": "When a safe is changed or deleted, a single backup copy of the safe is made (either locally or in iCloud, depending upon the location). This backup copy won’t be overwritten within a 24 hour period. Backups can be restored from the Restore Backups Settings menu. Backups are listed, along with the backup time, and may be restored by selecting and then tapping Restore. Backups may be removed by swiping the listed backup to the left and selecting Delete. Restored backup’s are renamed to avoid overwriting an existing safe. ", "url": "/assets/ios-man/en/3restore.html", "relUrl": "/3restore.html" },"8": { "doc": "Groups", "title": "Groups", "content": "Your password entries are organised into groups that you have defined. You can either tap All Groups, or you may wish to select a particular group. You can lock the safe manually by either using the back button (labeled Safes) or selecting . Clicking Edit allows creation, renaming and deletion of groups. Tapping allows you to Change safe password (including saved Touch ID/Face ID password if set). Note a group can only be deleted if there are no safe entries within it. ", "url": "/assets/ios-man/en/4groups.html", "relUrl": "/4groups.html" },"9": { "doc": "Entries", "title": "Entries", "content": "An entry contains the collection of attributes comprising: . | title | username | password (including previous passwords) | website url | comments | custom fields | . ", "url": "/assets/ios-man/en/5_Entries.html", "relUrl": "/5_Entries.html" },"10": { "doc": "Selecting an Entry", "title": "Selecting an Entry", "content": "Often the easiest way to find an entry is to tap All Groups and then use the search field. All fields (except the password field) are searched for the text you type into the search field. If you tap a particular entry, the password for that entry is copied to the clipboard and a notice displayed. You can then navigate to Safari or whichever application you are using and paste the password where it is required. (Note: passwords and other information copied from SamuraiSafe will not be shared with the Universal Clipboard.) . Alternatively, if you tap the button, you go to a screen showing the entry details. To minimise risk of unwanted disclosure, after a delay (default 1 minute), any data (such as a password) copied from the safe to the clipboard will be cleared from the clipboard. Under (Settings) Clear Clipboard allows you to alter the delay or disable this feature. Clicking + allows creation of a safe entry. ", "url": "/assets/ios-man/en/5select.html", "relUrl": "/5select.html" },"11": { "doc": "Password AutoFill", "title": "Password AutoFill", "content": "Password AutoFill simplifies login tasks for iOS apps and webpages. SamuraiSafe is integrated with the iOS password AutoFill mechanism. ", "url": "/assets/ios-man/en/62_autofill.html", "relUrl": "/62_autofill.html" },"12": { "doc": "Password AutoFill", "title": "Enabling AutoFill", "content": "AutoFill allows easy login using SamuraiSafe credentials to websites using Safari, or with Apps that support AutoFill. Your encrypted password store remains within SamuraiSafe, and the selected unencrypted password is only passed to iOS after a request is accepted by you, and you are authenticated by SamuraiSafe. The use of this feature is optional. To enable or disable Password AutoFill for SamuraiSafe go toiOS Settings / Passwords & Accounts / AutoFill Passwords (iOS 17)iOS Settings / General / AutoFill & Passwords (iOS 18): Select SamuraiSafe. Then select the SamuraiSafe safe you will be using for AutoFill. Only one safe may be selected for use by AutoFill at any time. On successful selection, a confirmation dialog will appear: . It is recommended you also disable Keychain (or iCloud Keychain) from the AutoFill Passwords settings panel, otherwise you will be presented with usernames from both sources. ", "url": "/assets/ios-man/en/62autofillenable.html#enabling-autofill", "relUrl": "/62autofillenable.html#enabling-autofill" },"13": { "doc": "Password AutoFill", "title": "Password AutoFill", "content": " ", "url": "/assets/ios-man/en/62autofillenable.html", "relUrl": "/62autofillenable.html" },"14": { "doc": "Using AutoFill", "title": "Using AutoFill", "content": "You use AutoFill from the login panel of a website or app. iOS will offer a suggested username or list of usernames, depending on what is available for that website in your Autofill safe. You can either click the suggestion, or click the key icon for futher options. On clicking the key icon, you get a list of all password entries that contain username and passwords. Select the entry you wish to use by tapping on that entry. Or you can use Search to find an entry. You can also examine entry details by clicking the icon, but editing isn’t possible here. The quicktype bar is only populated with entries in your safe that contain a username, password and valid homepage. If you find the AutoFill quicktype bar isn’t offering you the correct username, ensure the homepage field is correct. Homepage may be set to either the bare website domain name eg. www.google.com, or a complete URL eg. https://www.google.com/login. ", "url": "/assets/ios-man/en/62autofilluse.html", "relUrl": "/62autofilluse.html" },"15": { "doc": "Customising AutoFill", "title": "Customising AutoFill", "content": "AutoFill Settings are available for safe entries that have a username, password and homepage set, and the safe is configured for AutoFill in Settings/Passwords (available for safes upgraded to V2). An entry can be hidden from AutoFill, or the rank of the entry increased. (The highest ranked matching entry is suggested in the Quicktype bar). Additional hostnames may also be specified. Matching hosts will use the current entry username and password. This feature is intended for a group of websites that use the same login credential (and where seperate login credentials are not possible). ", "url": "/assets/ios-man/en/63customauto.html", "relUrl": "/63customauto.html" },"16": { "doc": "Viewing an Entry", "title": "Viewing an Entry", "content": "The entry details of your password entry are displayed. Selecting any field will copy that field to the clipboard so it can be pasted into an application of your choosing. To view the password, tap the button. This also shows the home page exactly as stored in the safe (without abbreviation). Using the button, the password is displayed as an overlay for better visibility. If you tap the entry password will be copied to clipboard and Safari (or other web browser selected in Settings) will open on the home page. The copy behaviour can be disabled (Copy Password on Open) in Settings. On an iPad in split view, you can drag and drop entry fields from SamuraiSafe. This is a very secure method of transferring data as the clipboard isn’t involved. SamuraiSafe tracks the last time the entry fields are changed, and the last time the password is changed — these are displayed at the bottom of the detail drawer history display if Show Timestamps: Entry Modified Dates is selected in Settings. ", "url": "/assets/ios-man/en/6view.html", "relUrl": "/6view.html" },"17": { "doc": "Using Password History", "title": "Using Password History", "content": "At the bottom of the entry viewing screen you can click Password History: . Previous passwords are displayed. If a historical password is selected, it is copied to the clipboard. Under Custom Entry Settings, if the switch is enabled, a custom password history setting will be applied to this entry only. Note that if this value is reduced below the number of currently saved previous passwords, the oldest passwords will be discarded. ", "url": "/assets/ios-man/en/7history.html", "relUrl": "/7history.html" },"18": { "doc": "Editing an Entry", "title": "Editing an Entry", "content": "Clicking Edit whilst viewing an entry allows you to edit the various safe entry fields and also generate passwords. Note the next to the notes field. Use this to add custom fields. The field name and value can each be set. Click the next to the custom field to delete a custom field. Tapping brings up a menu: Generate new password allowing a new password to be generated, or Generation settings allowing password generation options (see below) to be adjusted. The coloured line under the password indicates strength. Red is very weak, yellow is weak and green is good. The longer the line the stronger the password. Password generation options allow the generated passwords to be customised: . You have the option of generating sequences of random characters (as shown), numeric PIN numbers, or sequences of random English words (bottom section). After editing the entry, tap Done to save changes, or Cancel to leave the entry unchanged. ", "url": "/assets/ios-man/en/8editing.html", "relUrl": "/8editing.html" },"19": { "doc": "Filter and Audit Password Entries", "title": "Filter and Audit Password Entries", "content": "Apart from searching for text by typing into the search field, you can filter entries by age or password quality by touching and selecting Filter & Audit Tools. Filter by Changed Date: select entries with recent changes (entry text or password): . | modified today, | this week, | or this month. | . Filter by Password Age: filter by age of password: . | 6-12m, | 1-3yrs, | greater than 3 yrs. | . Filter by Password Quality: . | password strength (very weak and weak) | show shared passwords (i.e. used in more than one entry) | . ", "url": "/assets/ios-man/en/8filteraudit.html", "relUrl": "/8filteraudit.html" },"20": { "doc": "Settings", "title": "Settings", "content": "Clicking opens the Settings Menu. Set Open Read Only - Sets the initial disposition of the Open Read Only button when opening a safe. Auto-Lock - locks the safe after expiry of a time period (default 2 minutes). Lock on App Switch - locks the safe when you switch to another app (default off). Allow Touch ID Login or Allow Face ID Login - Enable/disable Touch ID/Face ID functionality. If turned off all stored Touch ID/Face ID safe passwords will be removed from your device. Grayed out if disabled in iOS settings. Autofill Safe - the iCloud safe being used for Password Autofill. Set via iOS Settings/Passwords and Accounts. Clear Clipboard - If you copy any data from a safe by clicking on an entry field, it is put into a clipboard shared with other iOS apps. This setting specifies the time elapsed before the shared clipboard is cleared. Safe Modified Date - Show the last modification date and time of each safe. Entry Modified Dates - Show the last modification date and time of each entry and each password, when viewing an entry’s detail. Username - the default value for username when creating a new safe entry. The default value may contain the string {title} - this is replaced on entry creation with a lowercase space cleansed copy of the entry title. Copy Password on Open - When asking the web browser to show an entry homepage, whether or not to copy the password to the clipboard (this is unnecessary on an iPad when using drag and drop). Password History . | Password History is the option to retain a specified number of previously used passwords. The Keep setting is a maximum number to be retained. This setting can be overriden on a per entry basis (up or down). Note that retaining a large number of old passwords may make your password safe grow in size significantly, so use this option judiciously. | Enabling Upgrade Safe on Open allows prompting to upgrade a password safe from the old format (V1) to the new format (V2) required to support password history, user defined fields, autofill settings. See help.samarama.net for further information on safe migration. | Reducing the Keep setting will not affect previous passwords already saved until a entry has a password updated. | . Appearance: sets app appearance to system, light or dark. Safe password minimum strength: sets the minimum password strength that will be accepted when creating a new safe or changing a safe password. Restore Backups - Open the Restore Backup dialog. See Restoring a Safe from Backups. ", "url": "/assets/ios-man/en/91prefs.html", "relUrl": "/91prefs.html" },"21": { "doc": "iCloud", "title": "iCloud", "content": "iCloud can be used to share SamuraiSafe Safes between iOS and macOS devices. To use iCloud, you need to be logged onto iCloud and have iCloud Drive enabled for SamuraiSafe. ", "url": "/assets/ios-man/en/93_iCloud.html", "relUrl": "/93_iCloud.html" },"22": { "doc": "Handling iCloud Conflicts", "title": "Handling iCloud Conflicts", "content": "If edits are made on the same safe on different devices, there is always the risk of a conflict occuring. iCloud takes time to propogate updates, and this process can be stalled due to network unavailability or slowness. Because of this, it is ideal to only make safe updates on the same device. However, this isn’t always practical and a conflict may occur. SamuraiSafe currently makes no attempt to reconcile differences between conflicts, so you need to do this yourself. If changes are received from iCloud for a safe whilst viewing or editing that safe, an alert will warn you that changes have been received. Editing will be disabled until the safe is reopened. A conflicted safe will be indicated in red, and on tapping the safe name a choice can be made as to which safe should become the winner in the conflict. The modify times and the devices involved will be shown. If you wish to keep both copies of the conflicted safe, this is possible by selecting all conflicts you wish to keep. A unique safe name will be generated for the additional copies. Note that if the Show File Dates setting is enabled, the last update time will be indicated for each safe. ", "url": "/assets/ios-man/en/93conflict.html", "relUrl": "/93conflict.html" },"23": { "doc": "Troubleshooting iCloud", "title": "Troubleshooting iCloud", "content": "iCloud usually ‘just works’, but occasionally there are circumstances when it doesn’t. Common issues are a failure to sync a safe, or a ’stuck’ (partly complete) sync. If this happens there are few things you can try which will usually resolve the issue: . Check: . | that your device is connected to the internet (try web browsing), | ensure you are logged on to iCloud and iCloud Drive is enabled for SamuraiSafe, | check the availability of the Apple iCloud Drive service: http://www.apple.com/support/systemstatus/ | . if the above doesn’t help, try: . | restarting your device (as this will restart the iCloud processes on your device), | disabling and then re-enabling iCloud Drive for SamuraiSafe, | if the above steps fail to resolve the issue, try logging out of iCloud completely, and then logging in again. | . Note that iCloud updates are not instantaneous. After relogging into iCloud on a device, it may be necessary to wait at least 10 minutes before the updates come through. The speed of restoration will no doubt depend on the network speed and the size of your iCloud data store. ", "url": "/assets/ios-man/en/94trouble.html", "relUrl": "/94trouble.html" },"24": { "doc": "About", "title": "About", "content": " ", "url": "/assets/ios-man/en/E_About.html", "relUrl": "/E_About.html" },"25": { "doc": "License and Acknowledgements", "title": "License", "content": "SamuraiSafe © 2011-2026 Michael Rourke. LICENSED APPLICATION END USER LICENSE AGREEMENT . ", "url": "/assets/ios-man/en/Elicense.html#license", "relUrl": "/Elicense.html#license" },"26": { "doc": "License and Acknowledgements", "title": "Acknowledgments", "content": "PasswordSafe: Program concept and UI design is inspired by PasswordSafe, originally written by Bruce Schneier www.schneier.com, Java derivative. ZXCVBN: © 2012-2016 Dan Wheeler and Dropbox, Inc. Google Toolbox for Mac © 2008 Google Inc. for XML escaping code - under the Apache License . The method of randomly generating passphrases from a word list is known as Diceware © 1995-2017 Arnold G. Reinhold . American English word list (filtered to approximately 21,000 words) from 12dicts package compiled by Alan Beale (12dicts@pobox.com). SwiftDomainParser © 2018 Dashlane. Parse URLs using the Public Suffix list. MIT License. PunycodeSwift © 2018 Gumob. Encode and decode punycoded strings by using String extension. MIT License. Just the Docs, a documentation theme for Jekyll used for these help pages. © 2017-2020 Patrick Marsceill. MIT License. German language localisation. © 2022 Henning Gärtner. ", "url": "/assets/ios-man/en/Elicense.html#acknowledgments", "relUrl": "/Elicense.html#acknowledgments" },"27": { "doc": "License and Acknowledgements", "title": "License and Acknowledgements", "content": " ", "url": "/assets/ios-man/en/Elicense.html", "relUrl": "/Elicense.html" },"28": { "doc": "Motivation", "title": "Motivation", "content": "I’m a software engineer with almost 40 years of professional software development experience. Working initially with UNIX operating system internals, then working on a broad range of network and operating system related applications built on a variety of Unices. I live in Sydney, Australia. My interests primarily are operating systems, network systems, infrastructure design, software quality management, software security and risks. SamuraiSafe was written to satisfy two goals. I was using a Java based password manager (Password Safe) which, whilst adequate, had some security issues, as the entire password file was decrypted and stored in memory whilst in use. Also being a non-native macOS application, it was slightly slow and clunky. I also wished to learn Objective-C, Cocoa, Appkit (macOS) and UIKit (iOS). SamuraiSafe is the result of satisfying those goals, whilst being a practical tool. I limited the scope to essential features, and standard frameworks: . | Binary (Atomic) Core Data is used for storage. Passwords and password entry data is only decrypted when required, to limit exposure of cleartext in memory. | Data stored in SamuraiSafe is encrypted using the AES algorithm with a 256 bit key. Each element (i.e. every group, password entry or password) is separately encrypted and includes a secure hash (HMAC), so corruption of encrypted data is detected, and any such corruption has limited effect. | iCloud Drive can be used to synchronise between macOS and iOS instances. Surprisingly Apple don’t make sharing of Core Data documents over iCloud between iOS and Mac easy1. | . I have added features based upon feedback and my own experience, however the philosophy is to keep it simple. See design.samarama.net for discussion of some common convenience features of password managers (e.g. web browser plugins) and their problems. I briefly experimented with a free and paid versions of the app, but realised I wouldn’t make much progress against well funded commercial products with marketing budgets. So I decided to keep maintaining the app as a hobby, as a convenience to anyone that finds it useful. For further information, comments, complaints or requests please email michael@samarama.net . Michael Rourke .   . | UIManagedDocument on iOS directly supports iCloud, however NSPersistentDocument on Mac doesn’t. ↩ . | . ", "url": "/assets/ios-man/en/Fmotivation.html", "relUrl": "/Fmotivation.html" },"29": { "doc": "SamuraiSafe User Guide", "title": " SamuraiSafe User Guide \nfor iOS", "content": " ", "url": "/assets/ios-man/en/", "relUrl": "/" },"30": { "doc": "SamuraiSafe User Guide", "title": "SamuraiSafe User Guide", "content": " ", "url": "/assets/ios-man/en/", "relUrl": "/" } }