Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #4

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added CHECKLISTS.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added LESSONS.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
237 changes: 235 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,235 @@
# Umbrella_ios
Umbrella for iOS devices
# Umbrella iOS

![](https://github.com/securityfirst/Umbrella_android/blob/master/howtouse.gif?raw=true)

Umbrella is a iOS application developed by [Security First](https://www.secfirst.org) that provides human rights defenders with the information on what to do in any given security situation and the tools to do it. It allows the user to choose what they want to do, such as: protect data; securely make a call/email; securely access the internet; plan secure travel; protect their office/home; conduct counter-surveillance; or deal with kidnapping, arrest or evacuation. Once a situation is chosen, the app outlines what to do and what tools to use given your circumstances. This is followed by a simple checklist of recommended actions that can be customised, saved and shared securely. Umbrella’s Feed also provides users with an up-to-the-minute account of potential risks in their chosen location.

## Installation on iOS

<a href="https://apps.apple.com/us/app/umbrella-security/id1453715310">
<img alt="Umbrella on Apple App Store"
src="https://github.com/PROTechThor/Umbrella_android/blob/ios-button/APPSTORE1.png?raw=true" height="80" width="220" /></a href>

## Available on Android

[Umbrella is also available on Android](https://github.com/securityfirst/Umbrella_android) devices.

<a href="https://play.google.com/store/apps/details?id=org.secfirst.umbrella">
<img alt="Umbrella on Google Play Store"
src="https://github.com/securityfirst/Umbrella_android/blob/master/GOOGLEPLAY1.png?raw=true" height="76" width="220"/></a href>
<a href="https://www.amazon.co.uk/Security-First-Umbrella-made-easy/dp/B01AKN9M1Y">
<img alt="Umbrella on Amazon App Store"
src="https://github.com/securityfirst/Umbrella_android/blob/master/AMAZON1.png?raw=true" height="80" width="220"/></a href>
<a href="https://secfirst.org/fdroid/repo">
<img alt="Umbrella on FDroid"
src="https://github.com/securityfirst/Umbrella_android/blob/master/FDROID1.png?raw=true" height="80" width="220" /></a href>

F-Droid fingerprint: 39EB57052F8D684514176819D1645F6A0A7BD943DBC31AB101949006AC0BC228


## Example Usage
Umbrella is designed for everyone (people looking to increase their security, folks living in high-risk areas, regular travellers, business people, techies, journalists, NGO staff, aid workers, human rights defenders, social workers, environmental activists, etc).

However, when we built Umbrella we tried to keep in mind the story of Glen Greenwald and Edward Snowden. Greenwald couldn't communicate with Snowden at the start because he found it cumbersome to set up encryption (he nearly missed one of the biggest stories of the decade because of this!). Also, when he (and Laura Poitras) travelled to Hong Kong - they didn't have much knowledge about how to meet securely with Snowden and detect surveillance. This is a common problem for journalists and activists. Umbrella is designed to solve this problem (and others) by having nearly everything they would have needed to know in one place - in their pocket.

## Main Parts of Umbrella

**Introduction:**
This is the part the user sees first. It explains briefly how the app works and the basic terms and conditions.

**Menu:** The bottom navigation menu is the main way for a user to navigate. It lists the feed, forms, lessons (with tool guides), checklists and account.

**Feed:**
The feed contains security feeds from places like the UN Relief Web and the US Centers for Disease Control. You enter your location (and how often you want to be updated). Every a new update is released (e.g a disease outbreak in your location), the information comes up on the dashboard.

**Lessons:**

![](/LESSONS.jpg)

Lessons are where users can learn about topics and things that they can do to improve their security. Some of the lessons have different levels (Beginner, Advanced, Expert) depending on your needs, ability, and risk. Each module is broken down into sections. At the end of each module is a list of other resources and further reading.

**Tool Guides:**
These are detailed guides about how to use software and apps mentioned in the lessons.

**Checklists:**

![](/CHECKLISTS.jpg)

Checklists are quick and easy references to help users implement the advice in the lessons. You can tick them off as you complete each item. Items can be edited. You may also create custom checklists. If you start ticking a checklist, you will then see them on the Checklists page. Checklists can also be shared through other apps such as your email.

**Forms:**
Forms allow a user to quickly fill out and share important information about issues such as their travel plan in a high-risk location or report on a digital/physical security incident.


## Lessons

The general flow of lessons is presented in order to replicate the typical way that a user works. Protecting their information -> Communicating with other people -> Arranging and travelling to a location -> Doing their operations and work -> Dealing with personal issues that may arise-> Seeking support if something goes wrong.

***These are the lessons currently in Umbrella.***

### Access your risk

- Security Planning

### Information

These lessons mostly cover the security of information that is stored on your computers.

- Managing information
- Malware
- Passwords
- Protecting Files
- Safely Deleting
- Backing Up
- Protect your workplace
- Workplace raids

### Communications

These lessons mostly cover the security of information when it is sent or received.

- Mobile Phones
- Making a call
- Sending a message
- Email
- Censorship
- Online Privacy
- Phishing
- Radios and satellite phones
- Online abuse

### Travel

These lessons cover the security of travelling in high-risk areas.

- Preparation
- Borders
- Vehicles
- Checkpoints
- Protective Equipment

### Work

These lessons include topics that may affect you in your work.

- Meetings
- Being followed
- Protests
- Dangerous Assignments
- Public Assignments
- Public Communications
- Whistleblowers

### Incident Response

These lessons cover how to respond to events.

- Arrests
- Evacuation
- Kidnapping
- Sexual Assault
- Terrorism

### Stress
- Stress

### Emergency Support

Explains places to get extra help if you have a problem.

- Physical
- Digital

### Tools

These are detailed guides about how to use software and apps mentioned in the lessons. These are the tools currently covered in the tool guide.

- Messaging
* Mailvelope
* ObscuraCam
* Pidgin
* Psiphon
* Signal for Android
* Signal for iOS
- Encryption
* Encrypt your iPhone
* k9 & Open Keychain
* KeePasXC
- PGP
* PGP for Linux
* PGP for MacOS
* PGP for Windows
- Tor
* Orbot & Orfox
* Tor for MacOS
* Tor for Linux
* Tor for Windows
- Files
* Cobian Backup
* Recuva
* VeraCrypt
- Other
* Android
* Facebook
## Glossary
Contains explanations of the various terms used in the app.

## About
Explains the licences that we use for and by Umbrella. Also says a big THANKYOU to everyone who's work we built on to make it happen.

## Dashboard Feed Sources
![](https://github.com/securityfirst/Umbrella_android/blob/master/DASHBOARDLOGOS.png)

These are the sources that we currently include for real-time updated security Feeds. For privacy reasons, users never connect directly to these services. We are always looking for more useful sources that will help users keep updated on the move.
* [ReliefWeb / UN](http://reliefweb.int): excellent physical security updates that amalgamate information from the UN and various NGOs - though not available in every country
* [Foreign and Commonwealth Office](https://www.gov.uk/government/organisations/foreign-commonwealth-office): foreign travel advice, consular help and services abroad and document legislation
* [Centers for Disease Control](https://www.cdc.gov): updates on disease and health warnings
* [Global Disaster Alert and Coordination System](http://www.gdacs.org): updates on natural disaster issues such as floods, earthquakes and tsunamis
* [US State Department Country Warnings](https://www.state.gov/travel/): updates mainly focused on the security situation for travellers and internationals - available for every country

## Account
Navigate to the "Account" from the menu on th left of the screen. Here you can:

* Modify settings (feed interval, feed location, feed sources, notifications, connections, import data, export data)
* Enable Mask
* Set a password
* Log out

## Requirements

Any browser on any device!

## Contributing

Thank you for your interest in contributing to Umbrella. See our [contributing guide](https://github.com/securityfirst/Umbrella_android/blob/5fd3847f6b716d750f42080983353a3a87f307dd/CONTRIBUTING.md).

### Contributors

Thanks to everyone who has contributed code to Umbrella. It wouldn’t
have happened without you.

- [Rok Biderman – Security First Lead Developer](https://github.com/Coccodrillo)
- [Vesna Planko – Security First Lead UI/UX Designer](https://github.com/VesnaPlanko)
- [Alex Guerrieri – Security First Developer](https://github.com/klaidliadon)
- [Adam Hani Schakaki – Security First Developer](https://github.com/krzd)

**Cryptography Notice**

This distribution includes cryptographic software. The country in which
you currently reside may have restrictions on the import, possession,
use, and/or re-export to another country, of encryption software. BEFORE
using any encryption software, please check your country's laws,
regulations and policies concerning the import, possession, or use, and
re-export of encryption software, to see if this is permitted.

See [_http://www.wassenaar.org/_](http://www.wassenaar.org/) for more
information.

**License**

Copyright 2013-2021 Global Security First Ltd. (trading as Security
First)

Licensed under the
GPLv3: [_http://www.gnu.org/licenses/gpl-3.0.html_](http://www.gnu.org/licenses/gpl-3.0.html)