Skip to content

Commit bfb0beb

Browse files
committed
Removing my email from image + fixing typos
1 parent 7031e1f commit bfb0beb

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

docs/src/admins.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ To administer Ego, the admin must:
1717

1818
a. Admin creates a new application in Ego with the client_id and password.
1919
b. Admin creates new policies with new policy names
20-
c. Admin Assign permissions to users/groups to permit/deny them access to the new application and policies
20+
c. Admin assigns permissions to users/groups to permit/deny them access to the new application and policies
2121

22-
**4. Admin creates or deletes groups, assigns user/group permissions, expire tokens, etc. as necessary.**
22+
**4. Admin creates or deletes groups, assigns user/group permissions, revoke tokens, etc. as necessary.**
2323

2424
For example, an administrator might want to:
2525

26-
- Create a new group called “QA”, whose members are all the people in the “QA department”
26+
- Create a new group called **“QA”**, whose members are all the people in the “QA department”
2727
- Create a group called “Access Denied” with access level “DENY” set for every policy in Ego
2828
- Grant another user administrative rights (role ADMIN)
2929
- Add a former employee to the group “AccessDenied”, and revoke all of their active tokens.

docs/src/gettingstarted.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,23 @@ Using `Docker <https://www.docker.com/>`_:
2121
2222
Ego should now be deployed locally with the Swagger UI at http://localhost:8080/swagger-ui.html
2323

24-
Alternatively, see the development :ref:`installation instruction `. instructions.
24+
Alternatively, see the `Installation instructions <installation.html>`_.
25+
2526

2627
How Ego Works
2728
-------------------------------------------
28-
**1. An Ego administrator configures Ego.**
29+
**1. An Ego administrator configures Ego.**
2930
- Registers a unique client-id and application password for each application that will use Ego for Authorization.
3031
- Creates a policy for every authorization scope that an application will use.
3132
- Registers users and groups, and sets them up with appropriate permissions for policies and applications.
3233

3334

34-
**2. Ego grants secret authorization tokens to individual users to represent their permissions**
35+
**2. Ego grants secret authorization tokens to individual users to represent their permissions.**
3536
- Authorization tokens expire, and can be revoked if compromised.
3637
- Individuals can issue tokens for part or all of their authority, and can limit the authority to specific applications.
3738
- Users (and programs operating on their behalf) can then use these tokens to access services.
3839

39-
**3. Individual services make a REST call to EGO to determine the user and authority represented by a token.**
40+
**3. Individual services make a REST call to EGO to determine the user and authority represented by a token.**
4041
- Makes a call to Ego's check_token endpoint and validates the user's authorization to access the requested services.
4142

4243

docs/src/jwt.png

-50.6 KB
Loading

docs/src/tokens.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,23 @@ Tokens
33

44
User Authentication Tokens
55
----------------------------------------------------
6-
Authentication concerns who the user is. User Authentication tokens are used to verify a user’s identity.
6+
Authentication concerns *who the user is*.
77

8-
Ego’s User Authentication tokens are signed JSON Web Tokens (see http://jwt.io) that Ego issues when a user successfully logs into Ego using their Google or Facebook credentials.
8+
User Authentication tokens are used to verify a user’s identity.
99

10-
Ego will then issue an authentication token, which confirms the user’s identity, and contains information about the user’s name, their role (user or administrator), and any applications, permissions, and groups associated with their Ego account.
10+
Ego’s User Authentication tokens are signed JSON Web Tokens (see http://jwt.io) that Ego issues when a user successfully logs into Ego using their Google or Facebook credentials.
1111

12-
An authentication token contains all of the information that ego has about a given user, including which groups they are a part of, which applications they are authorized to use , which permissions they have to use those applications.
12+
Ego's authentication tokens confirm the user’s identity, and contain information about a user’s name, their role (user/administrator), and any applications, permissions, and groups associated with their Ego account etc.
1313

14-
This data current as of the time the token is issued, and the token is digitally signed by Ego with a publicly available signing key that applications have to use to verify that an authentication token is valid. Most of Ego’s REST endpoints require an Ego authentication token to validate the user’s identity before operating on their data.
14+
This data is current as of the time the token is issued, and the token is digitally signed by Ego with a publicly available signing key that applications have to use to verify that an authentication token is valid. Most of Ego’s REST endpoints require an Ego authentication token to be provided in the authorization header, in order to validate the user’s identity before operating on their data.
1515

1616
.. image :: jwt.png
1717
1818
User Authorization Tokens
1919
----------------------------------------------------
20-
Authorization concerns what a user is allowed to do.
20+
Authorization concerns *what a user is allowed to do*.
21+
22+
User Authorization tokens are used to verify a user's permissions to execute on a desired scope.
2123

2224
Ego’s User Authorization tokens are random numbers that Ego issues to users so they can interact with Ego-aware applications with a chosen level of authority.
2325

@@ -27,12 +29,12 @@ Unlike passwords, Authorization tokens automatically expire, and they can be rev
2729

2830
The user can then use their token with Ego-authorized applications as proof of who they are and what they are allowed to do. Typically, the user will configure a client program (such as SING, the client program used with SONG, the ICGC Metadata management service) with their secret token, and the program will then operate with the associated level of authority.
2931

30-
In more detail, when an Ego-aware application wants to know if it authorized to do something on behalf of a given user, it just sends their user authorization token to Ego, and gets back the associated information about who the user is (their user id), and what they are allowed to do (the permissions associated with their token). If the permissions that the user have include the permission the application wants, the application know it is authorized to perform the requested service on behalf of the user.
32+
In more detail, when an Ego-aware application wants to know if it is authorized to do something on behalf of a given user, it just sends their user authorization token to Ego, and gets back the associated information about who the user is (their user id), and what they are allowed to do (the permissions associated with their token). If the permissions that the user have include the permission the application wants, the application know it is authorized to perform the requested service on behalf of the user.
3133

3234

3335
Application Authentication Tokens
3436
----------------------------------------------------
3537

3638
For security reasons, applications need to be able to prove to Ego that they are the legitimate applications that Ego has been configured to work with.
3739

38-
For this reason, every Ego-aware application must be configured in Ego with it’s own unique client_id and password, and the application must send an authentication token with this information to Ego whenever it makes a request to get the identity and credentials associated with a user’s authorization token.
40+
For this reason, every Ego-aware application must be configured in Ego with it’s own unique CLIENT ID and CLIENT SECRET, and the application must send a token with this information to Ego whenever it makes a request to get the identity and credentials associated with a user’s authorization token.

0 commit comments

Comments
 (0)