Codebook for macOS

Codebook Codebook for OS X

Introduction and Usage

What is CodebookEncrypted Data Vault

Guards passwords and private data

Keeps sensitive information organized

Enables quick recall of secrets

Syncs data across multiple devices

● iOS (iPhone / iPad)● Android● Windows● OS X

Security256-bit AES encryption

Peer-reviewed storage engine

Protection:

● Data at rest on device● Data at rest on cloud sync

service (Google Drive and Dropbox)

Getting Started

Master PasswordChoose Master Password on first use

Enter each time to access vault

All encryption uses a derived key

Can be any length but we recommend a password of at least 8 characters including 1 of each, capital, number, lowercase, and special character, ex: ! $ ?

Complex and difficult to guess

All instances that sync must have the same password

Don’t forget - no recovery

Welcome1. Toolbar2. Search3. Category List4. Entry List5. Entry View

1 2

3 4 5

Data modelCategory

● Groups records● Navigation-based retrieval

Entry

● Record with multiple fields; or● A multi-line note

Category

Entry

Data modelFields

● Store related data on an entry● e.g. username, password

Labels

● Define the Field type● Establish behavior (e.g. launch

email, generate password)

Field

Label

Create a Category1. New Category (or shift+⌘+N)2. Enter a descriptive name3. Choose an Icon4. Click Done

1

23

4

Create an Entry1. New Entry (or ⌘+N)2. Enter Descriptive Name3. Choose Icon4. Add Fields

a. Choose Labelb. Enter field value

5. Click the “Favorite Star” to mark important records as Favorites

6. Save changes

1

23

4

5

4a 4b

6

Special Labels & Behaviors● Password / PIN

○ Masked○ Supports random generation

● Note○ Free text entry

● Website○ Launches browser on double click

● Email○ Launches email client on double click

● TOTP○ Generates time-based one time passwords (e.g. for Google 2-step)

Create a Note1. Add Note Entry (or

option+⌘+N)2. First line becomes title3. Multi line text content4. Save note

1 2

3 4

Deleting records1. Delete category (and all entries)2. Delete entry (and all fields)3. Delete field

Be careful not to lose information, these operations cannot be undone.

1 2

3

Navigation and Retrieval

CategoriesNavigate through your own custom organization structure

1. Choose a Category from the navigation area

2. Choose an Entry to view

Categories and Entries are sorted alphabetically

1

2

FavoritesEntries marked with the Favorite star are quickly accessible

1. Click on Favorites2. Click on an Entry

1 2

SearchQuick retrieval of information based on keyword:

1. Enter search criteria2. Choose Entry to view

Entry names and all field values are included in search.

12

Copy / PasteData can be copied to the clipboard

1. Click on Field to be copied2. Click the copy button -or- type

⌘+C3. Paste into another app with

⌘+V

The clipboard is managed and fields you copy will be cleared automatically.

12

Secret Agent

Secret AgentGlobal keyboard shortcut to launch Codebook search from any app

Insert data into an active text field (e.g. a website password in your browser)

Available on Desktop Only

Use1. Press shift + ⌘ + \2. Enter search term3. Use up and down arrows or

mouse to navigate results4. Press return to select a search

result5. Arrow down or up to select a

Field (like Password)6. Press return to enter value to

active text field in another app

Tip: Favorite entries will sort to the top in Secret Agent.

Synchronization

Set Sync Preference

1. Select Codebook->Preferences

2. Select radio button of prefered sync method, either Desktop WIFI (sync on local WIFI network), Dropbox, Google Drive, or Local Sync Folder (local folder on your machine

3. When syncing to Dropbox or Google Drive, you will need to authenticate to the app once and the settings will be saved.

4. Desktop WIFI sync is initiated from the IOS or Android device.

How to sync1. Tap the Sync button2. Sign in to your Google account

to authenticate3. Sync will proceed after

authorization

Tip: Sync periodically to keep your data in sync across your devices.

1

SynchronizationCodebook can keep data in sync across multiple devices

Changes made on any device merge

All data is encrypted on Google Drive

Google Drive

Mobile

Desktop

Sync is triggered on each device on

demand

Changes are merged in the central copy on

Google Drive

Sync modes● Sync: bi-directional merge● Overwrite: Replaces remote

data● Restore: Overwrites local

changes

Use “Sync” mode periodically to keep your data up to date.

Use “Restore” mode to initialize a database on a brand new device.

Sync Overwrite Restore

How to sync1. Tap the Sync button2. Sign in to your Dropbox account

to authenticate3. Sync will proceed after

authorization

Tip: Sync periodically to keep your data in sync across your devices.

1

Synchronization

Codebook can keep data in sync across multiple devices

Changes made on any device merge

All data is encrypted on Dropbox

Mobile

Desktop

Sync is triggered on each device on

demand

Changes are merged in the central copy on

DropboxDropbox

Sync modes● Sync: bi-directional merge● Overwrite: Replaces remote

data● Restore: Overwrites local

changes

Use “Sync” mode periodically to keep your data up to date

Use “Restore” mode to initialize a database on a brand new device

Sync Overwrite Restore

Sync exampleComputer

1. Add a new entry in Codebook Desktop2. Start Sync3. Changes copied to Google Drive or Dropbox

9. Start Sync10. Mobile changes merged from Google Drive or Dropbox to Codebook Desktop

Mobile

4. Start Sync5. Desktop changes merged from Drive to Codebook Mobile6. Edit Entries on Codebook Mobile7. Start Sync8. Mobile changes copied to Google Drive or Dropbox

Important Preferences

Customize LabelsAdd new custom labels

Customize behaviors

Enable masking

Available under File -> Customize Labels (or ⌘+L)

AutolockLeaves application unlocked for a designated period of time (default 5 minutes)

Automatically locks application when timer expires

Allows more convenient access without repetitious logins

Tip: Be careful; when autolock is enabled your data is exposed.

Available under Codebook menu -> Preferences

Clipboard clearCodebook automatically wipes secrets from the system clipboard after 2 minutes.

Available under Codebook menu -> Preferences.

Secret Agent1. Check “Enable Secret Agent

with keyboard Command”2. Click the “Choose User Scripts

Folder” button3. Codebook will choose the

correct folder, simply click “Choose User Scripts Folder” again

4. Choose the key sequence to launch Secret Agent

1

2

3

4

Other Features

Password changeAvailable under Codebook menu -> Change Password

Password change *must* be completed simultaneously on all devices if Sync is used

After password change, run a “Overwrite” sync operation to replace the replica on Google Drive

BackupsBackups are snapshots of the database state at a point in time

Triggered

1. Manually on demand2. Automatically before each sync

operation3. Automatically before each

master password change

Backups are fully encrypted with your master password

Available under File menu -> Backups