File: README.md

package info (click to toggle)
openid4java 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,912 kB
  • sloc: java: 14,510; xml: 2,402; jsp: 865; makefile: 11
file content (121 lines) | stat: -rw-r--r-- 3,795 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
![OpenID4Java](openid4java.png)

**[中文(简体)](http://code.google.com/p/openid4java/wiki/ProjectHome_zh_CN)**


# What is this package? #

This library allows you to OpenID-enable your Java webapp.

The following specifications are supported:
  * [OpenID Authentication 2.0](http://openid.net/specs/openid-authentication-2_0.html)
  * [OpenID Authentication 1.1 (in compatibility mode)](http://openid.net/specs/openid-authentication-1_1.html)
  * [OpenID Attribute Exchange 1.0](http://openid.net/specs/openid-attribute-exchange-1_0.html)
  * [OpenID Simple Registration 1.0](http://openid.net/specs/openid-simple-registration-extension-1_0.html) and [1.1, draft 1](http://openid.net/specs/openid-simple-registration-extension-1_1-01.html)
  * [OpenID Provider Authentication Policy Extension 1.0](http://openid.net/specs/openid-provider-authentication-policy-extension-1_0.html)
  * [OpenID Information Cards 1.0, draft 1](https://openidcards.sxip.com/spec/openid-infocards.html)

# What is OpenID? #

OpenID starts with the concept that anyone can identify themselves on the
Internet the same way websites do - with a URI. Since URIs are at the very
core of Web architecture, they provide a solid foundation for user-centric
identity.

The first piece of the OpenID framework is authentication -- how you prove
ownership of a URI. Today, websites require usernames and passwords to
login, which means that many people use the same password everywhere. With
OpenID Authentication, your username is your URI, and your password (or
other credentials) stays safely stored on your OpenID Provider (which you
can run yourself, or use a third-party identity provider).

For more information about the OpenID protocol please refer to the
specification at: http://openid.net/specs.bml

# Quick Start #

To OpenID-enable a website - a Relying Party (RP) in OpenID terms, or Consumer at code-level, you need to do the following:

  * [Install](Installation.md) the libraries

  * Instead (or as an alternative to) prompting the user for their username/password, obtain their OpenID (URL) identifier

  * Create an authentication request for this identifier, and redirect the user to their OpenID Provider (with this request)

  * Receive the OpenID Provider's authentication response at your webapp's ReturnURL, and verify it

Have a look at the QuickStart page for a code-level walk-through the above, and at the SampleConsumer class for the full code.

The bulk of the action amounts to about a dozen lines of code.

# Simple-OpenID #

A working example of a simple (6 JSP files) OpenID Provider and Relying Party can be found under samples/simple-openid/.
Start it with:
```
mvn jetty:run
```
And access it at http://localhost:8080/simple-openid/

For more details see the README.txt file included in that folder.

# See also #

[Requirements](Requirements.md)

[Installation](Installation.md)

[Documentation](Documentation.md)

BuildFromSource

SampleConsumer

SampleServer

# Package contents #

[CHANGELOG](CHANGELOG)
Version highlight changes.

[INSTALL](INSTALL)
Installation and usage instructions.

[LICENSE](LICENSE)
OpenID4Java Library license (Apache 2.0).

[MAINTAINERS](MAINTAINERS)
List of code and documentation maintainers.

[README.md](README.md)
This file!

[TODO](TODO)
Tasks remaining and/or ongoing.

[VERSION](VERSION)
The released version of this package.

[apidoc/](apidoc)
JavaDoc API documentation.

[samples/](samples)
Sample implementation projects. See samples/README for details.

[src/](src)
Source code.

[test/](test)
Test cases source code and test data.

[lib/](lib)
Library dependencies.

[build.xml](build.xml)
Ant build file; see INSTALL / Building the package.

[project.properties](project.properties)
Build properties file.

[pom.xml](pom.xml)
Maven POM.