Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-06-29 15:22:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

SEC-1689: Adjust manual to remove references to separate crypto module.

Browse Source
This commit is contained in:
Luke Taylor 2011-03-08 12:58:28 +00:00
parent a50c9afbab
commit 57c3afd31a
3 changed files with 100 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/manual/src/docbook/appendix-dependencies.xml
View File

@ -412,12 +412,4 @@
</table> </table>
</para> </para>
</section> </section>
<section>
<title><literal>spring-security-crypto</literal></title>
<para>Provides convenient cryptographic APIs which are used by projects such as OAuth.
This module currently has no external dependencies.
</para>
</section>
</appendix> </appendix>

27
docs/manual/src/docbook/crypto.xml
View File

@ -2,28 +2,15 @@
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="crypto" xmlns:xlink="http://www.w3.org/1999/xlink"> <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="crypto" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Spring Security Crypto Module</title> <title>Spring Security Crypto Module</title>
<section id="spring-security-crypto-introduction"> <section xml:id="spring-security-crypto-introduction">
<title>Introduction</title> <title>Introduction</title>
<para> <para>
The Spring Security Crypto module provides support for symmetric encryption, key generation, and password encoding. The Spring Security Crypto module provides support for symmetric encryption, key generation, and password encoding.
The code is distributed as part of the core module but has no dependencies on any other Spring Security (or Spring) code.
</para> </para>
</section> </section>
<section id="spring-security-crypto-howtoget"> <section xml:id="spring-security-crypto-encryption">
<title>How to get</title>
<para>
Add the spring-security-crypto artifact to your classpath:
<programlisting language="xml"><![CDATA[
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-crypto</artifactId>
<version>${org.springframework.security-version}</version>
</dependency>]]>
</programlisting>
</para>
</section>
<section id="spring-security-crypto-encryption">
<title>Encryptors</title> <title>Encryptors</title>
<para> <para>
The Encryptors class provides factory methods for constructing symmetric encryptors. The Encryptors class provides factory methods for constructing symmetric encryptors.
@ -31,7 +18,7 @@
You can also construct TextEncryptors to encrypt text strings. You can also construct TextEncryptors to encrypt text strings.
Encryptors are thread safe. Encryptors are thread safe.
</para> </para>
<section id="spring-security-crypto-encryption-bytes"> <section xml:id="spring-security-crypto-encryption-bytes">
<title>BytesEncryptor</title> <title>BytesEncryptor</title>
<para> <para>
Use the Encryptors.standard factory method to construct a "standard" BytesEncryptor: Use the Encryptors.standard factory method to construct a "standard" BytesEncryptor:
@ -52,7 +39,7 @@ String salt = KeyGenerators.string().generateKey(); // generates a random 8-byte
</programlisting> </programlisting>
</para> </para>
</section> </section>
<section id="spring-security-crypto-encryption-text"> <section xml:id="spring-security-crypto-encryption-text">
<title>TextEncryptor</title> <title>TextEncryptor</title>
<para> <para>
Use the Encryptors.text factory method to construct a standard TextEncryptor: Use the Encryptors.text factory method to construct a standard TextEncryptor:
@ -76,7 +63,7 @@ Encryptors.queryableText("password", "salt");]]>
</section> </section>
</section> </section>
<section id="spring-security-crypto-keygenerators"> <section xml:id="spring-security-crypto-keygenerators">
<title>Key Generators</title> <title>Key Generators</title>
<para> <para>
The KeyGenerators class provides a number of convenience factory methods for constructing different types of key generators. The KeyGenerators class provides a number of convenience factory methods for constructing different types of key generators.
@ -118,7 +105,7 @@ KeyGenerators.string();]]>
</section> </section>
</section> </section>
<section id="spring-security-crypto-passwordencoders"> <section xml:id="spring-security-crypto-passwordencoders">
<title>Password Encoding</title> <title>Password Encoding</title>
<para> <para>
The password package of the spring-security-crypto module provides support for encoding passwords. The password package of the spring-security-crypto module provides support for encoding passwords.

6
docs/manual/src/docbook/introduction.xml
View File

@ -282,12 +282,6 @@
external OpenID server. <literal>org.springframework.security.openid</literal>. external OpenID server. <literal>org.springframework.security.openid</literal>.
Requires OpenID4Java.</para> Requires OpenID4Java.</para>
</section> </section>
<section xml:id="spring-security-crypto">
<title>Crypto - <literal>spring-security-crypto.jar</literal></title>
<para>Contains cryptography utility functions which are used by other
Spring projects. <literal>org.springframework.security.crypto</literal>.
</para>
</section>
</section> </section>
<section xml:id="get-source"> <section xml:id="get-source">
<title>Checking out the Source</title> <title>Checking out the Source</title>