Sovrain
  1. Documentation
  2. Password manager

Reference

Entries, fields and search

The entry templates, the field types and their settings, the search syntax, access levels, history, breach checks and limits of the password manager.

This page lists what an entry in the password manager can hold and how the Entries tab finds it. Labels from the screen are in bold.

Entry templates

New entry on the Entries tab offers these templates, in this order. A template only decides the fields a new entry starts with; you can add, remove and change fields afterwards, and the entry does not remember its template.

TemplateFieldsIndexedConcealed
Loginusername, password, website, one-time codeusername, websitepassword
Payment cardcardholder name, card number, expiry, security code, PINcard number (as Brand and last four), expirysecurity code, PIN
Bank accountbank, account holder, IBAN, BIC / SWIFT, online bankingbank, IBAN (as Last four)none
Secure notenotesnonenotes
Passportholder, number, issuing country, nationality, date of birth, sex, place of birth, personal number, issuing authority, date of issue, expiryholder, number (as Last three), issuing country, expirypersonal number
Identity cardholder, number, issuing country, nationality, date of birth, sex, place of birth, parents’ given names, family name at birth, personal number, issuing authority, date of issue, expiry, card access numberholder, number (as Last three), issuing country, expirypersonal number, card access number
Driving licenceholder, number, issuing country, categories, date of birth, place of birth, personal number, issuing authority, date of issue, expiry, restrictions, category datesholder, number (as Last three), issuing country, categories, expirypersonal number
Wi-Finetwork name, password, securitynetwork namepassword
Server / SSHhost, username, password, private key, host key fingerprinthost, usernamepassword, private key
API keyservice, key ID, secret, expiryservice, key ID, secret (as Last four), expirynone
Software licenceproduct, licence key, licensed to, purchase date, expiryproduct, expirylicence key

The online banking field of a Bank account is a link to another entry, for example your bank’s Login.

Field types

Add a field… in the entry editor adds a field of one of these types. The first choice under Show as is the one a new field starts with, unless another is marked as the default.

TypeShow asIndexed
Yes / noVisible, ConcealedAlways while Visible; there is no Indexed box
Date and timeVisible, ConcealedOptional, off by default
DateVisible, ConcealedOptional, on by default
MonthVisible, ConcealedOptional, on by default
Expiry date and timeVisible, ConcealedOptional, on by default
Expiry dateVisible, ConcealedOptional, on by default
Expiry monthVisible, ConcealedOptional, on by default
Single-line textVisible, First two and last two, Last four, Last three, ConcealedOptional, on by default
PasswordVisible, Concealed (default)Never
Multi-line textVisible, ConcealedNever
Web addressVisible, Origin only, ConcealedOptional, on by default
Email addressVisible, Masked address, ConcealedOptional, on by default
One-time codeVisible, ConcealedNever
Card numberVisible, Brand and last four (default), ConcealedOptional, on by default
BinaryVisible, Concealed (default)Never
Link to an entryVisible, ConcealedOptional, on by default

Some types behave in their own way:

  • Password fields have the Generate buttons, a strength badge, the breach check and Set on (below).
  • Multi-line text of more than 8 KiB is stored as a long note, an encrypted file of at most 256 KiB that counts towards your organization’s storage.
  • Web address gets https:// in front when you type an address without a scheme; saving tells you so and asks you to confirm. javascript:, data:, blob:, vbscript:, about: and file: addresses are refused.
  • The expiry types show a badge in the list from 30 days before the date: expires in 12 days, expires today, then expired.
  • One-time code takes a base32 seed or an otpauth://totp/… link; see Store two-step codes.
  • Binary holds up to 8 KiB of bytes, typed in an encoding you choose, generated with 128 bit key or 256 bit key, or read with Load from file. Save as file downloads them.
  • Link to an entry points to another entry in your vault and shows its title. An entry you cannot open shows No access.

Field settings

Each field in the editor has its name at the top, with ↑, ↓ and × to move or remove it, and these settings under its value.

Show as
How much of the value the open entry shows before you select Show. Visible shows all of it, Concealed shows ••••, and the masked forms show parts of it:
Show asExample
First two and last twosk••••EF
Last four••••2874
Last three••••567
Masked addressan••••yk@gmail.com
Origin onlyhttps://mail.acme.example/••••
Brand and last fourVisa ••••2356

A masked form shows fewer characters, or only ••••, when the value is short.

Indexed
Puts the value in your vault’s index, as the open entry shows it before Show: in full, or as its masked form. Search finds the entry by indexed values, and the list shows the first two indexed fields under the title without opening the entry. Indexed values are encrypted like the rest, but your browser decrypts all of them every time you unlock the vault. A Concealed value is never indexed; the box is greyed out. Saving a field that is less private than before (shown more fully, or newly indexed) asks you to confirm.
Set on
On a Password field only: the day the password came into use at the website. A new password gets today when you save it. When you change a saved password, Sovrain asks “Did the password change at the service?”: OK sets today, Cancel keeps the old date. Tick Set date unknown when you do not know it. The open entry shows the date as Set and the day. The breach check uses it (see Breach checks).
Fills
Tags that name what the field holds for a form, such as Username, Password, One-time code or Card number, chosen in Fills…, or a Custom tag…. A tag can be on only one field of an entry.
Issuer from, Account from
On a One-time code field only: the fields that name the website and your account in the QR code the entry can show.

Generated passwords

The Generate buttons of a password field make random passwords from 57 letters and digits. Letters and digits that look alike (l, I, O, 0, 1) are left out.

ButtonCharacters
Good password12
Strong password16
128 bit key22
256 bit key44

Hold the pointer over a button to see the strength it gives.

The search box on the Entries tab finds entries by their title and their indexed values. Every term you type must match (there is no OR and no exclusion).

You typeIt finds
kowal, acme mailWords of one value, the last one as the start of a word: kowal finds Kowalczyk, acme.ex finds acme.example
"acme corp"These characters in this order inside one value, spaces and punctuation included
2027, 2027-03, 2027-03-31Date, Month and the expiry types by their date; Date and time by the day in your time zone
*@gmail.com, sk*EF, PL?1*Values whose whole shown form fits the pattern: * stands for any run of characters, ? for exactly one
has:iban, has:"card number"Entries that have a field with that name, whatever its settings and whether or not it is set
iban:2874, "card expiry":2028, lifetime:trueThe term (a word, phrase, date or pattern) in that one indexed field only
  • Upper and lower case and accents do not matter: lodz finds Łódź, strasse finds Straße.
  • Terms with fewer than 3 letters or digits are ignored, and the box says “Terms under 3 characters are ignored”. has: terms and dates count whatever their length; * and ? do not count as characters.
  • A plain term never matches a field’s name, only values. A Yes / no value is found only by its name, as in lifetime:true.
  • Masked values are matched as they are shown: 2874 finds ••••2874, and * also covers ••••. What the mask hides is not in the index, so it cannot be found.
  • Values that are not indexed, and concealed values, are never searched.
  • Search looks through the folder you are viewing and the folders under it, as one list. From My vault it looks through every entry, and from Shared with me through the entries there.
  • Archived entries are included only while Show archived is ticked.
  • While a search matches a field that the list does not show, the entry’s row shows that field under the title.

Access levels

What a person or group can do with an entry shared with them:

AccessCan
Can viewOpen the entry, show and copy its values, download its files, see its History and who can see it
Can editAlso Edit, Archive and Restore the entry, and Restore this version from its history
Can edit and shareAlso give, change and remove access under Who can see this, use Share with everyone who can read, and share the entry with Share folder…
  • The person who creates an entry gets Can edit and share.
  • Every entry keeps at least one person or group with Can edit and share; Sovrain refuses a change that would remove the last one.
  • You can share with people of your organization who have set up a vault, and with any group, shown as Group and its name.
  • Removing someone’s access, or someone leaving a group the entry is shared with, marks the entry someone lost access: change this password.

How to share: Share an entry or a folder.

History and archive

  • Every save, archive and restore adds a version to the entry’s History, with its number, time and author. Sovrain keeps every version; an entry or a version cannot be deleted.
  • Restore this version saves an older version as the newest one. It needs Can edit, and appears only next to versions your browser can open.
  • Someone you share an entry with gets the version current at that moment and every later one, not the earlier history.
  • Archive saves a version that keeps only the title and the indexed values. The entry’s other details stay in its history. Restore saves the last version that had them as the newest one.
  • Files removed from an entry stay in the versions that had them, so they keep counting towards your organization’s storage.

Breach checks

The breach checks run in your browser, which contacts these services directly. Sovrain’s server takes no part.

  • Known breached passwords. Your browser computes the password’s SHA-1 hash and sends only its first 5 characters to the Pwned Passwords service, which answers with every known hash starting with them. The browser compares the answer itself, so the password never leaves the browser. This runs for a new vault password, for a password you type or generate in an entry, and for the passwords of an entry each time you open it. Check all passwords checks every entry that is not archived, at most once in 24 hours per browser.
  • Breached websites. Your browser fetches the list of breaches from Have I Been Pwned and the public suffix list from publicsuffix.org, each at most once a day, and compares the web addresses in your entries with them by their registrable domain (for example acme.example for mail.acme.example). An entry is marked when its website was breached on or after the day before its password’s Set on date, or when that date is not known. Only entries with a password and a Web address that is indexed, starting with https:// or http://, are compared.
  • These services see your IP address and the 5-character hash prefixes, never a password.

The Third-party notices link at the bottom of the password manager lists the services. How to use the checks: Check for breached passwords.

Limits

WhatLimit
Title, field name, single-line value255 bytes
Multi-line text8 KiB in the entry; up to 256 KiB as a long note
Web address8 KiB
Binary value8 KiB
Indexed part of an entry16 KiB
Whole entry, without long notes and files256 KiB
Attachment8 MiB per file
Entry icon16 KiB
Files, long notes and icons of the whole organization1 GiB by default
Folders1000, at most 8 levels deep, names up to 255 bytes
DatesYears 0001 to 9999

Where your organization runs Sovrain itself, the operator sets the organization’s storage; see Server configuration. All limits of Sovrain: Limits.