inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

REPO-3176: Remove version badges

Browse Source
This commit is contained in:
dcaruana
2018-01-12 13:58:01 +00:00
parent e903cc6268
commit b54c003bd1
2 changed files with 41 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/identity-provider/authentication/README.md
View File

@@ -2,14 +2,12 @@
![Completeness Badge](https://img.shields.io/badge/Document_Level-In_Progress-yellow.svg?style=flat-square)
![Version Badge](https://img.shields.io/badge/Product-Alfresco_Content_Services_5.2-blue.svg?colorB=2196f3&style=flat-square?colorB=2196f3&style=flat-square)
### Purpose
The purpose of this sub-component is to authenticate users.
***
***
### Overview
### Overview
In order to use any service in Alfresco, a user must be authenticated.
@@ -21,18 +19,18 @@ to integrate with a number of external Authentication providers including
* NTLM
* LDAP
***
***
### Artifacts and Guidance
* Source Code Links:
* Source Code Links:
* https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root/enterpriseprojects/repository/source/java/
* https://github.com/Alfresco/alfresco-data-model/tree/master/src/main/java/org/alfresco/repo/security/authentication
* License: LGPL
* Issue Tracker Link: https://issues.alfresco.com/jira/issues/?jql=project%3DREPO
* Documentation Link: http://docs.alfresco.com/5.2/concepts/auth-intro.html
* Contribution Model: Alfresco Open Source
***
***
### Prerequisite Knowledge
@@ -44,7 +42,7 @@ to integrate with a number of external Authentication providers including
* [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol)
* [NTLM](https://msdn.microsoft.com/en-us/library/windows/desktop/aa378749(v=vs.85).aspx)
***
***
### Design
@@ -53,11 +51,11 @@ to integrate with a number of external Authentication providers including
In order to use any service in Alfresco, a user or client must be authenticated.
There is a default implementation provided that authenticates users based on a userid and password, where the userid's and passwords
are stored in the Alfresco repository.
are stored in the Alfresco repository.
#### Chaining
Most production systems that use Alfresco will rely upon more secure approaches, so Alfresco also allows the
Most production systems that use Alfresco will rely upon more secure approaches, so Alfresco also allows the
customer to integrate a choice of existing authentication providers, including *Active Directory*, *Kerberos*, *LDAP* and *NTLM*.
The implementation of each such Authorization provider is delivered as a separate Alfresco Subsystem.
@@ -65,7 +63,7 @@ The Subsystems are chained together as an ordered list of providers each of whic
a chance to authenticate the user, until the user is authenticated or there are no providers, in
which case the authentication of the user fails.
#### Component Model
#### Data Model
@@ -75,10 +73,10 @@ which case the authentication of the user fails.
#### Flows
##### Login Flow
##### Login Flow
##### Default Authentication Login Flow
This flow starts when the Login Post request
This flow starts when the Login Post request
depicted in [Client Login](../../../share/share-app/resource/sequence/client-login-sequence.png) reaches the repository tier.
![Default Authentication Login Flow](./resource/sequence/login-using-default-authentication.png)
@@ -96,13 +94,13 @@ depicted in [Client Login](../../../share/share-app/resource/sequence/client-log
### APIs and Interfaces
#### Java
The sub-component provides a definition and implementation of the following
The sub-component provides a definition and implementation of the following
Java interfaces.
* **Authentication Service**
* **Authentication Service**
**Note**: This service is part of the Public API
* authenticate using a user name and password
* authenticate using a ticket
@@ -113,19 +111,19 @@ Java interfaces.
* get a ticket for subsequent re-authentication
* determine if the current user is 'the system user
* **MutableAuthenticationService*
In addition, there are a number of related interfaces that provide
a way to manage users and groups and permissions
In addition, there are a number of related interfaces that provide
a way to manage users and groups and permissions
![Note](https://img.shields.io/badge/Editor-Note-yellow.svg?&style=flat-square?colorB=2196f3&style=flat-square)
*This information should probably move to the Identity sub-component after the content already there (future design thoughts)
*This information should probably move to the Identity sub-component after the content already there (future design thoughts)
is relocated*
* **Authority Service**
**Note**: This service is part of the Public API
* create authority identifiers
* create authority identifiers
* query for authority identifiers
* delete authority identifiers
* organize authority identifiers into hierarchies
* organize authority identifiers into hierarchies
* query against authority identifiers hierarchies
* find all the authorties that apply to the current authenticated user
* determine if the current authenticated user has admin rights
@@ -141,25 +139,25 @@ is relocated*
* determine if a person entry exists for a user
* create missing people entries, with default settings, on demand
* supply a list of mutable properties for each person
* create, delete and update personal information
***
* create, delete and update personal information
***
#### REST
The sub-component provides the following REST API
* https://api-explorer.alfresco.com/api-explorer/#/authentication
* https://api-explorer.alfresco.com/api-explorer/#/authentication
### Configuration
***
***
### Performance Considerations
![Note](https://img.shields.io/badge/Editor-TODO-yellow.svg?&style=flat-square?colorB=2196f3&style=flat-square)
Describe Caching of tickets
As mentioned in the *Security Considerations* section, Bcrypt can be used to encrypt passwords. Note that is
is much slower than MD4 or SHA-256.
***
***
### Security Considerations
***
***
In the case of the default Authentication provider, Alfresco is responsible for storing
userid's and passwords. The passwords are stored as hashed values. The default hashing
algorithm used is MD4, but the customer can also elect to use more secure hashing algorithms
@@ -171,4 +169,3 @@ to select which algorithm is used.
![Note](https://img.shields.io/badge/Editor-TODO-yellow.svg?&style=flat-square?colorB=2196f3&style=flat-square)
Describe OAuth2 for protection of Cloud REST API's.
***

32
docs/meta-data-services/versions/README.md
View File

@@ -1,17 +1,15 @@
## Component Name
## Versions
![Completeness Badge](https://img.shields.io/badge/Document_Level-In_Progress-yellow.svg?style=flat-square)
![Version Badge](https://img.shields.io/badge/Version-5.2-orange.svg?style=flat-square)
### Purpose
***
***
### Overview
### Overview
***
***
### Artifacts and Guidance
@@ -20,12 +18,12 @@
* Issue Tracker Link: https://issues.alfresco.com/jira/secure/RapidBoard.jspa?projectKey=REPO&useStoredSettings=true&rapidView=379
* Documentation Link: http://docs.alfresco.com/5.1/concepts/versioning.html
* Contribution Model: Alfresco publishes the source code and will review proposed patch requests
***
***
### Prerequisite Knowledge
***
***
### Design
@@ -61,11 +59,11 @@ version.store.enableAutoVersionOnUpdateProps=true
#### Class Diagram
***
***
### APIs and Interfaces
***
***
### Configuration
@@ -93,22 +91,22 @@ If the values are found in the properties file they have the effect of overridin
The effect of these properties can be overridden by Share using a set of two properties:
* autoVersion
* autoVersion
* autoVersionProps
The values of these overrides are contained in the file _upload.post.config.xml_ such as in this example
The values of these overrides are contained in the file _upload.post.config.xml_ such as in this example
```
<autoVersion>true</autoVersion>
<autoVersionProps>false</autoVersionProps>
```
***
***
### Performance Considerations
***
***
### Security Considerations
***
***
### Cloud Considerations
None
@@ -117,6 +115,4 @@ None
### Design Decisions
***
***