Este proyecto proporciona soporte para usar Spring Security con OAuth (1a) y OAuth2. Ofrece funcionalidades para implementar tanto consumidores como proveedores de estos protocolos utilizando los modelos de programación e idiomas de configuración estándar de Spring y Spring Security.

Código de Conducta

Este proyecto se adhiere al código de conducta de Contributor Covenant. Al participar, se espera que cumplas con este código. Por favor, informa de comportamiento inaceptable a [email protected].

Comenzando

Descarga o clona desde GIT y luego usa Maven (3.0.*) y Java (1.6 o superior):

$ git clone ...
$ mvn install -P bootstrap

Usa el perfil bootstrap solo la primera vez: habilita algunos repositorios que no pueden estar expuestos en los poms por defecto. Puede resultarte útil añadir este perfil a tu settings.xml local.

Necesitas ejecutar Redis para que la compilación funcione. Puedes instalarlo usando homebrew. Sin Redis en ejecución, la compilación generará muchas excepciones de conexión de Jedis.

Los usuarios de SpringSource ToolSuite (o usuarios de Eclipse con el último plugin m2eclipse) pueden importar los proyectos como proyectos Maven existentes.

Spring Security OAuth se publica bajo los términos de la Licencia de Software Apache, Versión 2.0 (ver license.txt).

Ejemplos

Los ejemplos y las pruebas de integración están en un subdirectorio. Allí hay un README aparte para orientación e información. Una vez que hayas instalado los artefactos localmente (según las instrucciones de "Comenzando" anteriores) deberías poder

$ cd samples/oauth2/tonr
$ mvn tomcat7:run

y visitar la aplicación en tu navegador en http://localhost:8080/tonr2/ para comprobar que funciona. (Esto es para el ejemplo de OAuth 2.0; para el ejemplo de OAuth 1.0a solo elimina el "2" de la ruta del directorio). Las pruebas de integración requieren ajustes ligeramente diferentes para Tomcat, por lo que necesitas añadir un perfil:

$ cd samples/oauth2/tonr
$ mvn integration-test -P integration

Historial de cambios

Las listas de incidencias abordadas por versión se pueden encontrar en github (las versiones más antiguas están en JIRA).

Recursos adicionales

• Guía de usuario de Spring Security OAuth
• Código fuente de Spring Security OAuth
• Stackoverflow

Contribuir a Spring Security OAuth

Aquí hay algunas formas de involucrarte en la comunidad:

• Participa en la comunidad de Spring en los foros de la comunidad de Spring. Por favor, ayuda en el foro respondiendo preguntas y uniéndote al debate.
• Crea incidencias de github para errores y nuevas funciones, y comenta y vota en aquellas que te interesen.
• Github es para codificación social: si quieres escribir código, animamos a contribuir mediante pull requests desde forks de este repositorio. Si quieres contribuir código de esta manera, por favor referencia también una incidencia de github que cubra el problema específico que estás abordando.
• Estate atento a los próximos artículos sobre Spring suscribiéndote a springframework.org

Antes de aceptar un parche o pull request no trivial, necesitaremos que firmes el acuerdo de contribuyente. Firmar el acuerdo de contribuyente no otorga a nadie derechos de commit en el repositorio principal, pero sí significa que podemos aceptar tus contribuciones, y recibirás crédito como autor si lo hacemos. A los contribuyentes activos se les podría pedir que se unan al equipo principal y se les podría dar la capacidad de fusionar pull requests.

Convenciones de código y mantenimiento

Nada de esto es esencial para un pull request, pero todo ayuda. También se puede añadir después del pull request original pero antes de una fusión.

• Usa las convenciones de formato de código de Spring Framework. Importa eclipse-code-formatter.xml desde la raíz del proyecto si usas Eclipse. Si usas IntelliJ, copia spring-intellij-code-style.xml a ~/.IntelliJIdea*/config/codestyles y selecciona spring-intellij-code-style en Settings -> Code Styles.
• Asegúrate de que todos los nuevos archivos .java tengan un comentario de clase Javadoc simple con al menos una etiqueta @author que te identifique, y preferiblemente al menos un párrafo sobre para qué sirve la clase.
• Añade el encabezado de licencia ASF a todos los nuevos archivos .java (cópialo de archivos existentes en el proyecto).
• Añádete como @author a los archivos .java que modifiques sustancialmente (más que cambios cosméticos).
• Añade algunos Javadocs y, si cambias el espacio de nombres, algunos elementos de documentación XSD.
• Algunas pruebas unitarias también ayudarían mucho: alguien tiene que hacerlo.
• Si nadie más está usando tu rama, por favor haz rebase contra el master actual (u otra rama objetivo en el proyecto principal).