branch-2.0.4-alpha/hadoop-common-project/hadoop-auth/src/site/apt/index.apt.vm

~~ Licensed under the Apache License, Version 2.0 (the "License");
~~ you may not use this file except in compliance with the License.
~~ You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License. See accompanying LICENSE file.

  ---
  Hadoop Auth, Java HTTP SPNEGO ${project.version}
  ---
  ---
  ${maven.build.timestamp}

Hadoop Auth, Java HTTP SPNEGO ${project.version}

  Hadoop Auth is a Java library consisting of a client and a server
  components to enable Kerberos SPNEGO authentication for HTTP.

  Hadoop Auth also supports additional authentication mechanisms on the client
  and the server side via 2 simple interfaces.

  Additionally, it provides a partially implemented derivative of the Kerberos
  SPNEGO authentication to allow a "mixed" form of authentication where Kerberos
  SPNEGO is used by non-browsers while an alternate form of authentication
  (to be implemented by the user) is used for browsers.

* License

  Hadoop Auth is distributed under {{{http://www.apache.org/licenses/}Apache
  License 2.0}}.

* How Does Auth Works?

  Hadoop Auth enforces authentication on protected resources, once authentiation
  has been established it sets a signed HTTP Cookie that contains an
  authentication token with the user name, user principal, authentication type
  and expiration time.

  Subsequent HTTP client requests presenting the signed HTTP Cookie have access
  to the protected resources until the HTTP Cookie expires.

* User Documentation

  * {{{./Examples.html}Examples}}

  * {{{./Configuration.html}Configuration}}

  * {{{./BuildingIt.html}Building It}}

  * {{{./apidocs/index.html}JavaDocs}}

  * {{{./dependencies.html}Dependencies}}