From da14d1fc9087d3fee871e42ca633d1329b5f5be3 Mon Sep 17 00:00:00 2001 From: Maxim Baz Date: Thu, 18 Apr 2019 15:55:47 +0200 Subject: [PATCH] Document password searching (#124) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 130b5fd..472cee2 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ In order to use Browserpass you must also install a [companion native messaging - [First steps in browser extension](#first-steps-in-browser-extension) - [Available keyboard shortcuts](#available-keyboard-shortcuts) - [Password matching and sorting](#password-matching-and-sorting) + - [Searching password entries](#searching-password-entries) - [OpenID authentication](#openid-authentication) - [Modal HTTP authentication](#modal-http-authentication) - [Password store locations](password-store-locations) @@ -169,6 +170,20 @@ The sorting algorithm implemented in Browserpass will use several intuitions to 1. Password entries with the identical usage counts are sorted by number of domain levels (specificity), i.e. `wiki.example.com` will be above `example.com`. 1. If all the above is equal, password entries are sorted alphabetically. +### Searching password entries + +The search box allows you to filter the list of currently displayed password entries in the popup. If you are searching for a password entry that is not already visible (for example if it doesn't match the current domain), first press Backspace to disable phishing attack protection and search the entire password store (see [First steps in browser extension](#first-steps-in-browser-extension) for details). + +The search algorithm combines fuzzy and substring filtering approaches to achieve the most optimal results. The matching parts of each result are highlighted in a different color. + +The first word in the search term activates the fuzzy filtering and takes into consideration password store name, folder and password entry name: + +![fuzzy-search](https://user-images.githubusercontent.com/1177900/56358004-9b23eb80-61dd-11e9-9af9-3583c7969732.png) + +All subsequent words in the search term additionally filter our the remaining results using a substring filtering on folder and password entry name. + +If you would prefer to use substring search only, simply enter a space character prior to your search term - this disables fuzzy search entirely. + ### OpenID authentication OpenID is often used when someone doesn't trust (or doesn't want to need to trust) a website with their authentication credentials. For this reason, to prevent leaking credentials Browserpass considers OpenID and username+password authentications mutually exclusive: when `openid:` field is present in a password entry, Browserpass will _only_ attempt to fill the OpenID field in a form, it will not even attempt to fill username and password fields, even if they are also present in the password entry, even if a website contains username and password fields in a login form.