saife-endpoint-notes.md

Notes on Documentation and Links to Code Snippets

Overview

Getting Started

Downloading the Endpoint Source Code

• not exactly sample code, but after 'c++' and 'java' there should be bulleted lists that need an extra line of whitespace before them

Installation

Developer Account

Start Coding

• could update the list of examples:
  • SaifeMessageDemo
    • C++: point-to-point secure messaging
    • Java: secure group messaging
  • SAIFEDARDemo - demonstrating Data At Rest feature
  • SAIFENSDemo - demonstrating Network Share capabilities, using S3 for an example

API Overview

Saife Interface

SaifeFactory Class

Anatomy of a SAIFE Application

Initialize

• currently in debate whether we can pass null to SaifeFactory.constructSaife(), so better to give something
  • uncomment second logMgr line, add logMgr to constructSaife()
• do not need InvalidCredentialException and only need IOException when dealing with file I/O(using FileSinkManager

Generate keypair

• need to include entropy, see snippet

Update SAIFE Data

• need to unlock before you update

Unlock SAIFE

• AdminLockedException does not exist any more

Subscribe for messages

Synchronize contacts

Send Secure Messages

• saife.getContactByAlias() is deprecated, use saife.getContactsByName() and get index 0 instead
  • e.g. final Contact contact = saife.getContactsByName(sendTo).get(0);

Receive Secure Messages

Enable presence

Initiate session

Accept session

Questions & Additional Resources

Release Notes

Acknowledgments

Gists and Snippets

Secure Group Messaging

Create Group

snippet

Delete Group

snippet

Add Member to Group

snippet

Remove Member from Group

snippet

Send Message to Group

snippet

Receive Messages from Group(callback)

snippet

Leave a Group

snippet

Network Share(NS)

Retrieve a Network Share

snippet

Share a Network Share

snippet

Data At Rest(DAR)

Create Volume

snippet

Delete Volume

snippet

Miscellaneous

Generate Entropy

See earlier gist