Configuración de Seguridad para Acceso Autenticado a los Web Services

CONFIGURACIÓN NECESARIA

• Handlers: para poder tener acceso al API de GAM la cual permite gestionar el acceso a los servicios mediante un token de acceso, el archivo web.config debe contener en la sección de handlers el elemento:

<add name="GeneXus.Http.GXOAuthAccessToken" verb="*" path="GXOAuthAccessToken.aspx" type="GeneXus.Http.GXOAuthAccessToken,GxClasses" />

• Usuario: es recomendable crear un usuario en el GAM para para permitir el acceso exclusivo a los web services.

• Roles y Permisos: Se debe crear un rol específico para el uso de los web services con los permisos de los web services expuestos y este rol debe ser asignado al usuario que se utilizará para la conexión. Por cada web service expuesto sobre una transacción Genexus existen permisos relacionados, a continuación se muestra una Pantalla donde se puede observar el detalle de estas asignaciones:

Entre los tipos de Servicios (Service) están:

• Execute
  Permite operaciones GET

• Insert
  Permite operaciones POST

• Delete
  Permite operaciones DELETE

• Update
  Permite operaciones PUT

• FullControl
  Permite realizar GET, POST, PUT y DELETE sobre el web service.

Adicionalmente los tipos de permisos a nivel de ROL de usuario son:

• Allow:
  Un usuario que tiene un rol con un permiso de Tipo de acceso = Allow (Permitir) tendrá este permiso a menos que se le haya otorgado este permiso con Tipo de acceso = Deny (Denegar), o tenga otro rol donde se niegue el mismo permiso.

• Deny:
  Un usuario que tiene un rol con un permiso de Tipo de acceso = Deny (Denegar) no tendrá este permiso independientemente de si el permiso está permitido a nivel de aplicación (por defecto) o si tiene otro rol donde el permiso está permitido. La única forma en que el usuario puede obtener este permiso es con Tipo de acceso = Allow (Permitir).

• Restricted
  Si un permiso está restringido a la función de un usuario, él no tiene este permiso a menos que el usuario tenga este permiso con Tipo de acceso = Allow (Permitir) o tenga otra función donde se permita el mismo permiso.

WEB SERVICE DE AUTENTICACIÓN

• ACCESS TOKEN

Para obtener el token de acceso es necesario realizar POST con los parámetros (Recomendable hacerlo con aplicaciones como POSTMAN), para ello se deben tener los paramentos listados a continuación (Se indican a modo de ejemplo):

Donde los parámetros client_id y client_secret deben obtenerse de los parámetros de la aplicación en el GAM, esta información puede ser revisada en el menú Configuración - Seguridad - Configuración de la Aplicación.

PETICIÓN DE ACCESO

• Una petición POST a (Recomendable hacerlo con aplicaciones como POSTMAN).

 Instalación de POSTMAN

Para la Autenticacion y consumo de los Web Services indicados debemos tener instalado en tu equipo de trabajo alguna aplicación para probar acceso a la REST API de SIFCO WEB, para ello recomendamos uno de los mas usados como es POSTMAN y a continuación detallamos su instalación como extensión de Google Chrome, dado a que la misma es independiente del Sistema Operativo (SO) que estés utilizando, sin embargo es importante acotar que dicha aplicación también se puede instalar directamente en tu equipo, pero el instalador a utilizar dependerá del SO que estés ejecutando en ella.

INSTALACIÓN DE POSTMAN COMO EXTENSIÓN DE GOOGLE CHROME

Primero debe acceder a siguiente link

Luego debes darle clic al botón de AGREGAR A CHROME

Luego en la ventana del pop-up que se muestra en la imagen debes dar clic en AGREGAR APP

Y luego verificar que comience la descarga en la barra inferior, y una vez culminado (debe ser un proceso bastante rápido), verificar que la aplicación esta en tu listado de extensión y aplicaciones de Google Chrome.

Una vez instalado puedes iniciarlo y configurar los parámetros indicados en esta guía para la obtención del token y el consumo de los Web Services

Si necesitas información adicional de como utilizar POSTMAN, te adjunto dos paginas que pueden ser de mucha ayuda para ello.

Paginas e Apoyo Adicionales para la Instalación y utilización de POSTMAN

• https://openwebinars.net/blog/instalacion-y-primeros-usos-de-postman/

• https://dominicode.com/postman-tutorial-espanol/

HTTP://<SERVER>/<APPDIR>/oauth/access_token

Incluyendo en el body:

client_id=1234561ad52a42919a221bc796d0d6b0&client_secret=1111114313d243dd987b3aadb250e63b&granttype=password&scope=FullControl&username=admin&password=admin123

• Como respuesta se obtendrá un JSON con el token de acceso el cual deberá utilizarse en el encabezado de petición de consumo de los objetos expuestos

{ 
"access token" : "c9919e10e118"
"scope" : "FullControl"
}

CONSUMO DE WEB SERVICE

• Estructura de la Petición:

Para la petición se debe tomar en cuenta el tipo de método (GET, POST, PUT, DELETE) a utilizar el el formato que en todo caso debe ser siempre JSON. Por ello se provee una estructura genérica de la misma como ejemplo:

HTTP://<SERVER>/<APPDIR>/rest/WEB_SERVICE/PARM_1/PARM_2/PARM_N

• Encabezados obligatorios:

Cuando se ha habilitado en la Aplicación SIFCO WEB, el acceso de un usuario vía REST API de forma segura, a través del GeneXus Access Manager (GAM) con la propiedad de Nivel de Seguridad Integrada activa en las opciones de Autorización o Autenticación, deben enviarse los encabezados necesarios al servicio para evitar que el servicio responda con un error HTTP 401. Para evitar eso se debe incluir en la cabecera del llamado HTTP, lo siguientes encabezados y poder consumir dicho Web Service de forma segura sin riegos a que dicha solicitud sea rechazada.

Content-Type: application/json
Authorization: OAuth <Access Token>
GENEXUS-AGENT: SmartDevice Application

Mientras el token sea válido, el servicio responderá con el estado HTTP 200 OK y devolverá los datos solicitados. Si el token pasado en los encabezados ya no es válido, el servicio devolverá un error HTTP que debe quedar atrapado en el código de control del usuario.

Para profundizar sobre este punto puede remitirse a siguiente link, donde se detalla como es el llamado de Web Service, tipo Restfull, de forma segura por un usuario habilitado para ello desde el GeneXus Access Manager (GAM) .