@Firma Global Xmlsoap Man

7/26/2019 @Firma Global Xmlsoap Man

1/305

[email protected]

TELVENTTELVENTTELVENTTELVENT 1/305 [email protected] de Programacin de Web Services de @firma 5.01

Manual de Programacin de Web Servicesde @firma 5.1

Documento n: TI-20-1178-@Firma-Global-XMLSOAP-MAN

Revisin: 017.6

Fecha: 25-09-2007

Perodo de retencin: Permanente durante su perodo de vigencia + 3 aos despus de su anulacin


2/305

[email protected]


CONTROL DE COMPROBACCONTROL DE COMPROBACCONTROL DE COMPROBACCONTROL DE COMPROBACIN Y APROBACININ Y APROBACININ Y APROBACININ Y APROBACIN


Revisin: 017.6Fecha: 25-09-2007

REALIZADOREALIZADOREALIZADOREALIZADO

09-12-2005

Raquel

Yubero

Salmoral

Analista Firma Electrnica

COMPROBADOCOMPROBADOCOMPROBADOCOMPROBADO

06-08-2007

Rafael Carlos

Vzquez

Carmona

Director tcnico @Firma

APROBADOAPROBADOAPROBADOAPROBADO06-08-2007

Rafael Carlos

Vzquez

Carmona

Director tcnico @Firma


3/305

[email protected]


CONTROCONTROCONTROCONTROL DE MODIFICACIONESL DE MODIFICACIONESL DE MODIFICACIONESL DE MODIFICACIONES


Revisin: 017.6Fecha: 25-09-2007

Rev. 1

Fecha 09-12-2005

Autor/es RYS

Descripcin Documentacin inicial

Rev. 2Fecha 19-12-2005

Autor/es RYS

Descripcin Se han aadido al documento los anexos correspondientes a la descripcin de cdigos deresultado devueltos por la plataforma y a un ejemplo de integracin de la plataforma haciendouso de los Web Services. Se ha actualizado el xsd de solicitud y respuesta. Se ha actualizado elwsdl de los servicios web ValidarCertificado y ObtenerInfoCertificado.

Rev. 3

Fecha 10-01-2006

Autor/es RYS

Descripcin Actualizacin de los WSDL y mensajes SOAP de los servicios web.

Rev. 4

Fecha 26-01-2006

Autor/es RYS

Descripcin Actualizacin de los xml de salida y esquemas para soportar certificados de persona jurdica y e-DNI.

Rev. 5

Fecha 6-02-2006Autor/es RYS

Descripcin Actualizacin del mensaje SOAP de respuesta error para el WS ObtenerInfoCertificado. Aadidola descripcin para el WS ValidarFirma. Aadida informacin de integracin va OCSPResponder. Actualizacin de los Namespaces de los documentos xml de entrada, salida yschemas de todos los WS.


4/305

[email protected]


Rev. 6

Fecha 7-02-2006

Autor/es RYSDescripcin Actualizacin los mensajes SOAP de respuesta ya que se devuelven firmados.

Rev. 7

Fecha 10-02-2006

Autor/es RYS

Descripcin Adicin de cdigos de validacin devueltos por la plataforma.

Rev. 8


Descripcin Actualizacin de la codificacin de las peticiones SOAP y mensajes de entrada de la plataforma aISO-8859-1. Actualizados el puerto de acceso al OCSPResponder y protocolos de acceso a laplataforma va WS.

Rev. 9

Fecha 24-02-2006

Autor/es RYS

Descripcin Correccin del dominio redinteradministrativa.

Rev. 10

Fecha 27-02-2006

Autor/es RYS

Descripcin Actualizacin de los puertos por el cual realizar una peticin OCSP Responder y WS (usando elprotocolo http).

Rev. 11

Fecha 02-03-2006

Autor/es RYS

Descripcin Actualizacin de la codificacin de las peticiones SOAP y mensajes de entrada de la plataforma aUTF-8.

Rev. 12

Fecha 18-04-2006

Autor/es RYS

Descripcin Actualizacin del XSchema de los servicios web de Validacin para indicar que los elementosfechaRevocacion y motivo de InfoMetofoVerificacion pueden no aparecer en el resultado del


5/305

[email protected]


servicio web de validacin correspondiente.

Rev. 13Fecha 08-06-2006

Autor/es JAMC

Descripcin Adicin del cdigo de validacin clasificacion devuelto por la plataforma y de los valores quepuede tomar.

Rev. 14

Fecha 09-06-2006

Autor/es RYS

Descripcin Actualizados los valores que puede tomar el cdigo de validacin clasificacin.

Rev. 14.1

Fecha 19-06-2006

Autor/es RCVC

Descripcin Adicin del campo numeroSerie en el certificado patrn

Rev. 14.2

Fecha 21-06-2006

Autor/es ABL

Descripcin Revisin del campo clasificacin a valores iguales al de la DPC.

Rev. 15

Fecha 22-06-2006

Autor/es RYS

Descripcin Actualizacin de los mensajes SOAP de respuesta firmados. Actualizacin del Servicio WebValidarFirma. Adicin de los Servicios Web del Mdulo de Firma y de Custodia. Actualizacin delXSchema para los Servicios Web del Mdulo de Firma. Inclusin del XSChema para los ServiciosWeb del mdulo de Custodia.

Rev. 15.1


Descripcin Posibilidad de realizar en una nica peticin OCSP la validacin de varios certificados.

Rev. 16

Fecha 26-07-2006

Autor/es RYS

Descripcin Nivel de securizacin de peticiones XMLSOAP a la plataforma. Actualizacin de los WS del


6/305

[email protected]


mdulo de firma. Adicin de nuevos WS en el mdulo de firma. Actualizacin de los WS delmdulo de custodia. Adicin de nuevos WS en el mdulo de custodia. Actualizacin de losXSchemas del mdulo de firma y custodia. Adicin de nuevos cdigos de error devueltos por laplataforma.

Rev. 17Fecha 19-09-2006

Autor/es JLHA

Descripcin Actualizacin del WS de Firma por Bloques para contemplar la nueva funcionalidad demultifirma selectiva de documentos en bloques. Adicin del nuevo WSobtenerInfoCompletaBloqueFirmas. Actualizacin del XSchemas del mdulo de firma.

Rev. 17.1

Fecha 11-10-2006

Autor/es JLHA

Descripcin Aadida aclaracin en los WS de ValidarCertificado y ObtenerInfoCertificado. Aadidaexplicacin del funcionamiento del WS de Firma Servidor.

Rev. 17.2

Fecha 17-11-2006

Autor/es DGM

Descripcin Se ha incluido informacin de uso sobre el WS de Obtencin de Informacin de Certificados.Posibilidad de recepcin de campos vacos en algunos certificados y recomendacin de acceso alos campos por sus nombres y no por el orden en que aparezcan.

Rev. 17.3

Fecha 12-02-2007

Autor/es RCVC

Descripcin Se incorpora el campo tokenOCSP en la informacin de los mtodos de validacin OCSPutilizados para la validacin del estado de revocacin de los certificados en el servicio webValidarCertificado.

Rev. 17.4

Fecha 05-06-2007

Autor/es RCVC

Descripcin Se modifica el esquema del servicio ValidarCertificado. El elemento fechaUltimaActualizacionpasa a ser opcional.

Se modifica el servicio ValidarFirma. El campo certificadode las respuestas se modifica y pasa adevolverse el certificado en Base64 en lugar de una cadena de caracteres con informacin noparseable.

Rev. 17.5

Fecha 06-08-2007

Autor/es JARL


7/305

[email protected]


Descripcin Se ha modificado la descripcin del codigo de resultado 4 del proceso de validacin decertificados.

Rev. 17.6Fecha 25-09-2007

Autor/es MMIG

Descripcin Se ha actualizado la lista de cdigos de error.


8/305

[email protected]


CONTROL DE DISTRIBUCCONTROL DE DISTRIBUCCONTROL DE DISTRIBUCCONTROL DE DISTRIBUCININININ


Revisin: 017.65Fecha: 25-09-2007

Copias Electrnicas:

La distribucin de este documento ha sido controlada a travs del sistema de informacin.

Copias en Papel:

La vigencia de las copias impresas en papel est condicionada a la coincidencia de su estado de revisin

con el que aparece en el sistema electrnico de distribucin de documentos.

El control de distribucin de copias en papel para su uso en proyectos u otras aplicaciones esresponsabilidad de los usuarios del sistema electrnico de informacin.

Fecha de impresin 01/09/2009 1:29

Distribucin en Papel:

Nombre o Cargo y(Organizacin)

N de Ejemplares Referencia de la carta detransmisin y fecha


9/305

[email protected]


ndicendicendicendice

1 Objeto (06/12/2005)................................................................................................................ 14

2 Alcance (06/12/2005) .............................................................................................................. 14

3 Siglas (30/11/2005).................................................................................................................. 14

4 Descripcin de Interfaces Web Services (26/7/2006)........................................................... 15

4.1 Mdulo_Validacin. Validacin de Certificado (8/06/2006)............................................. 17

4.1.1 ValidarCertificado.wsdl........................................................................................ 17

4.1.2 Mensaje SOAP de peticin................................................................................... 18

4.1.3 Mensaje SOAP de respuesta OK. ........................................................................ 19

4.1.4

Mensaje SOAP de respuesta Error....................................................................... 26

4.2 Mdulo_Validacion. Obtencin de Informacin de Certificado (17/11/2006). ................. 29

4.2.1 ObtenerInfoCertificado.wsdl................................................................................ 29

4.2.2 Mensaje SOAP de peticin.................................................................................. 30


4.2.4 Mensaje SOAP de respuesta Error........................................................................ 35

4.3 Mdulo_Firma. Validar Firmas (12/07/2006).................................................................... 38

4.3.1 ValidarFirma.wsdl ................................................................................................ 38




4.4

Mdulo_Firma. Firma Servidor (21/06/2006). .................................................................. 454.4.1 FirmaServidor.wsdl .............................................................................................. 46




4.5 Mdulo_Firma. Firma Servidor CoSign (21/06/2006). ...................................................... 53

4.5.1 FirmaServidorCoSign.wsdl ................................................................................... 53




4.6 Mdulo_Firma. Firma Servidor CounterSign (21/06/2006)............................................... 60

4.6.1

FirmaServidorCounterSign.wsdl........................................................................... 604.6.2 Mensaje SOAP de peticin.................................................................................. 62



4.7 Mdulo_Firma. Firma Usuario 3 Fases F1 (21/06/2006). .................................................. 68

4.7.1 FirmaUsuario3FasesF1.wsdl ................................................................................. 68




10/305

[email protected]



4.8 Mdulo_Firma. Firma Usuario 3 Fases F1 CoSign (21/06/2006). ...................................... 75

4.8.1 FirmaUsuario3FasesF1CoSign.wsdl...................................................................... 75

4.8.2

Mensaje SOAP de peticin.................................................................................. 764.8.3 Mensaje SOAP de respuesta OK. ........................................................................ 77


4.9 Mdulo_Firma. Firma Usuario 3 Fases F1 CounterSign (21/06/2006)............................... 83

4.9.1 FirmaUsuario3FasesF1CounterSign.wsdl.............................................................. 83





4.10.1FirmaUsuario3FasesF3.wsdl ................................................................................. 90

4.10.2Mensaje SOAP de peticin.................................................................................. 91

4.10.3Mensaje SOAP de respuesta OK. ........................................................................ 92

4.10.4Mensaje SOAP de respuesta Error........................................................................ 95


4.11.1FirmaUsuario2FasesF2.wsdl ................................................................................. 97

4.11.2Mensaje SOAP de peticin.................................................................................. 98

4.11.3Mensaje SOAP de respuesta OK. ...................................................................... 100

4.11.4Mensaje SOAP de respuesta Error...................................................................... 102

4.12 Mdulo_Firma. Validar Firma Bloques Completo (26/07/2006). .................................... 105

4.12.1ValidarFirmaBloquesCompleto.wsdl .................................................................. 105

4.12.2Mensaje SOAP de peticin................................................................................ 106



4.13 Mdulo_Firma. Validar Firma Bloques Documento (26/07/2006)................................... 112

4.13.1ValidarFirmaBloquesDocumento.wsdl................................................................ 112




4.14 Mdulo_Firma. Firma Usuario Bloques F1 (26/07/2006). ............................................... 119

4.14.1FirmaUsuarioBloquesF1.wsdl ............................................................................. 120




4.15

Mdulo_Firma. Firma Usuario Bloques F3 (26/07/2006). ............................................... 128

4.15.1FirmaUsuarioBloquesF3.wsdl ............................................................................. 128




4.16 Mdulo_Firma. Obtener Identificadores Documentos Bloque Firmas (26/07/2006). ...... 135

4.16.1ObtenerIdDocumentosBloqueFirmas.wsdl ......................................................... 135



11/305

[email protected]




4.17 Mdulo_Firma. Obtener Identificadores Documentos Bloque Firmas Backwards

(26/07/2006). ................................................................................................................ 143

4.17.1ObtenerIdDocumentosBloqueFirmasBackwards.wsdl ........................................ 143




4.18 Mdulo_Firma. Obtener Informacion Bloque Firmas (26/07/2006). ............................... 150

4.18.1ObtenerInformacionBloqueFirmas.wsdl............................................................. 150




4.19 Mdulo_Firma. Obtener Informacion Bloque Firmas Backwards (26/07/2006). ............ 157

4.19.1

ObtenerInformacionBloqueFirmasBackwards.wsdl ............................................ 157




4.20 Mdulo_Firma. Obtener Informacion Completa Bloque Firmas (21/09/2006)................ 164

4.20.1ObtenerInfoCompletaBloqueFirmas.wsdl........................................................... 164




4.21 Mdulo_Custodia. Almacenar Documento (21/06/2006).............................................. 174

4.21.1AlmacenarDocumento.wsdl .............................................................................. 174

4.21.2

Mensaje SOAP de peticin................................................................................ 175



4.22 Mdulo_Custodia. Eliminar Contenido Documento (21/06/2006)................................. 181

4.22.1EliminarContenidoDocumento.wsdl .................................................................. 181




4.23 Mdulo_Custodia. Obtener Contenido Documento (21/06/2006). ............................... 188

4.23.1ObtenerContenidoDocumento.wsdl.................................................................. 188




4.24 Mdulo_Custodia. Obtener Contenido Identificador de Documento (26/07/2006)...... 194

4.24.1ObtenerContenidoDocumentoId.wsdl............................................................... 195




4.25 Mdulo_Custodia. Obtener Identificador Documento (21/06/2006). ............................ 201


12/305

[email protected]


4.25.1ObtenerIdDocumento.wsdl ............................................................................... 201



4.25.4

Mensaje SOAP de respuesta Error...................................................................... 206

4.26 Mdulo_Custodia. Actualizar Referencia (21/06/2006). ................................................ 208

4.26.1ActualizarReferencia.wsdl.................................................................................. 208




4.27 Mdulo_Custodia. Obtener Transacciones Por Fecha (21/06/2006)............................... 215

4.27.1ObtenerTransaccionesPorFecha.wsdl................................................................. 215




4.28

Mdulo_Custodia. Obtener Transacciones (21/06/2006)............................................... 2224.28.1ObtenerTransacciones.wsdl ............................................................................... 222




4.29 Mdulo_Custodia. Obtener Transacciones Referencia (26/07/2006). ............................ 229

4.29.1ObtenerTransaccionesReferencia.wsdl............................................................... 229




4.30 Mdulo_Custodia. Obtener Firma Transaccin (21/06/2006). ....................................... 236

4.30.1ObtenerFirmaTransaccion.wsdl.......................................................................... 236




4.31 Mdulo_Custodia. Obtener Bloque Firmas (26/07/2006)............................................... 243

4.31.1ObtenerBloqueFirmas.wsdl................................................................................ 243




5 Integracin va OCSP Responder (06/7/2006) .................................................................... 250

ANEXO............................................................................................................................................ 251

A.1 Sintaxis del XML de solicitud y respuesta (26/07/2006).................................................. 251

A.1.1 XSchema de web services para los WS de Validacin ........................................ 251

A.1.2 XSchema de web services para los WS de Firma................................................ 257

A.1.3 XSchema de web services para los WS de Custodia .......................................... 274

A.2 Cdigos de resultado devueltos por la plataforma.(06/08/2007)................................... 283

A.2.1 Cdigos resultado. ............................................................................................ 283

A.2.2 Cdigos de error. .............................................................................................. 284


13/305

[email protected]


A.3 Integracin con la plataforma mediante de Web Services.(26/07/2006) ........................ 290


14/305

[email protected]


1

Objeto (06/12/2005)

El objeto de este documento es describir las interfases WebServices de la plataforma @Firma

5.1 para que los desarrolladores de aplicaciones puedan integrar y utilizar los serviciosofrecidos por la misma.

2

Alcance (06/12/2005)

Este documento cubre los siguientes aspectos:

Descripcin de la interfaz de Servicios web de la plataforma @Firma mediante laespecificacin de mensajes XML-SOAP de solicitud y respuesta.

XSchema general asociado al XML de los parmetros de entrada y salida de los servicios web.

Descripcin de los cdigos de resultado devueltos por la plataforma.

Ejemplo de integracin con la plataforma a travs de los Web Services.

3

Siglas (30/11/2005)

TI Telvent Interactiva

SOAP Simple Object Access Protocol

WSDL Web Service Description Language

WS Web Services

OCSP Online Certificate Status Protocol


15/305

[email protected]


4

Descripcin de Interfaces Web Services (26/7/2006)

La plataforma @firma5.1 publicar servicios web de:

- Validacin de certificados.

- Obtencin de informacin de certificados.

- Validacin de firma electrnica

- Firma Servidor.

- Firma Servidor CoSign

- Firma Servidor CounterSign

-Firma Usuario 3 Fases F1

- Firma Usuario 3 Fases F1 CoSign

- Firma Usuario 3 Fases F1 CounterSign

- Firma Usuario 3 Fases F3

- Firma Usuario 2 Fases F2

- Firma Usuario Bloques F1

-Firma Usuario Bloques F3

- Validar Firma Bloques Completo

- Validar Firma Bloques Documento

- Obtener Identificadores de Documentos de un Bloque de Firmas generado por @firma4.0

- Obtener Identificadores de Documentos de un Bloque de Firmas.

- Obtener Informacin de un Bloque de Firmas generado por @firma 4.0

-Obtener Informacin de un Bloque de Firmas.

- Almacenar Documento.

- Eliminar el Contenido de un Documento.

- Obtener Identificador de un Documento.

- Obtener el Contenido de un Documento.


16/305

[email protected]


- Obtener el Contenido de un Documento haciendo uso de su identificador.

- Actualizar Referencia.

-Obtener Transacciones de Firma

- Obtener Transacciones de Firma por Fecha.

- Obtener la Firma Electronica de una Transaccin.

- Obtener Transacciones de Firma por Referencia.

- Obtener Bloque de Firmas.

El protocolo de acceso a dichos servicios se define mediante un mensaje de peticin y otrorespuesta al mismo. Ambos mensajes se intercambian haciendo uso del protocolo XML-SOAP

siendo obligatorio que dicha peticin sea realizada en codificacinsiendo obligatorio que dicha peticin sea realizada en codificacinsiendo obligatorio que dicha peticin sea realizada en codificacinsiendo obligatorio que dicha peticin sea realizada en codificacin UTFUTFUTFUTF----8 va http (por el8 va http (por el8 va http (por el8 va http (por elpuerto 8080) o httpspuerto 8080) o httpspuerto 8080) o httpspuerto 8080) o https.

Las peticiones XMLSOAP en funcin de la aplicacin que realice la misma debern estar1:

Sin securizar.

Securizadas haciendo uso de usuario/password

Firmadas.

La plataforma devolver los mensajes SOAP de respuesta firmados haciendo uso del certificadopblico de la misma. Para ello es necesario que se confe en el certificado pblico suministradoen las siguientes rutas del Kit de integracin (afirmaws.zip que podr ser descargado desde lapgina principal de la plataforma):

Entorno de Pre-produccion: \certificados\pre-afirma.redinteradministrativa.es\WS

Entorno de Pre-produccion: \certificados\afirma.redinteradministrativa.es\WS

Los servicios web publicados reciben como nico parmetro de entrada un String con formatoXML. Para cada servicio publicado existir un formato de XML especfico que vendr definido porun XML Schema determinado.

En el anexo A.1 se definen los diferentes esquemas XML que definen los mensajes de peticin y

respuesta que se pasn como parmetro en la peticin Web Service.

1Ver Anexo A.3 Integracin con la plataforma mediante de Web Services.(26/07/2006)


17/305

[email protected]


4.1

Mdulo_Validacin. Validacin de Certificado (8/06/2006)

ValidarCertificado representa al servicio web encargado de validar un certificado X509, incluido

e-DNI.4.1.1

ValidarCertificado.wsdl


18/305

[email protected]


4.1.2

Mensaje SOAP de peticin.

ValidarCertificado1.0

[idAplicacion][idAplicacion][idAplicacion][idAplicacion]

[modo][modo][modo][modo]

[obtenerInfo][obtenerInfo][obtenerInfo][obtenerInfo]

Cada uno de los parmetros enumerados se identifican con:


19/305

[email protected]


Certificado: Contenido del certificado a validar codificado en Base 64.

idAplicacion: Identificador de la aplicacin que realiza la peticin.

modoValidacion: Su valor podr ser:

- 0, para una validacin simple. Donde se validar la caducidad, integridad yconfianza del certificado.

- 1, para una validacin intermedia. Donde se validar la misma informacin delcaso 0 + estado de revocacin.

- 2, para una validacin compleja. Donde se validar la misma informacin del caso1 + validacin de la cadena de confianza al completo.

obtenerInfo: Su valor ser un boolean que especifique si se desea extraer informacindel certificado a validar o no.

4.1.3

Mensaje SOAP de respuesta OK.

MIICsTCCAhqgAwIBAAIEQ8zySzANBgkqhkiG9w0BAQUFADCBnDEgMB4GCSqGSIb3

DQEJARYRc29wb3J0ZS5ydEBtYXAuZXMxCzAJBgNVBAYTAkVTMQ8wDQYDVQQIEwZN

YWRyaWQxDzANBgNVBAcTBk1hZHJpZDEMMAoGA1UEChMDTUFQMQwwCgYDVQQLEwNN

QVAxLTArBgNVBAMTJHByZS1hZmlybWEucmVkaW50ZXJhZG1pbmlzdHJhdGl2YS5l

czAeFw0wNjAxMTcxMzM0MDNaFw0zMzA2MDQxMzM0MDNaMIGcMSAwHgYJKoZIhvcN

AQkBFhFzb3BvcnRlLnJ0QG1hcC5lczELMAkGA1UEBhMCRVMxDzANBgNVBAgTBk1h

ZHJpZDEPMA0GA1UEBxMGTWFkcmlkMQwwCgYDVQQKEwNNQVAxDDAKBgNVBAsTA01BUDEtMCsGA1UEAxMkcHJlLWFmaXJtYS5yZWRpbnRlcmFkbWluaXN0cmF0aXZhLmVz

MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpmDks3oqpTVhj69pu3gZtU3fd

MLv2sEPW4yq5/DZb4nWhhufwwUKHJrBtDadJyCv6x9sUaJEQMI9fyiP3br4t3So3

VC2+ki3ouUqAM7R1oWd0qbxn7xZ4qN5UvwgSGbJLmT9omi8CqeIAAecJt/Jhd3CR

MMknvDg2TKiH9Y2j2wIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAH12TSqTvkyY8Odn

Ervl6814griyxw+DkLcYXQN3L2/0OTZTV/wUElsar2KzGacmTQykH3zQeyt4hOMf


20/305

[email protected]


FX3A6cMuLyVzgc4Eoo6B3hGeRuaUoa92OxbwX79iBcYoIFGgxmgPrQUi1dHeuxQq

1uLg9O8Bhhp3saZfk56Ta7CegbG5

51LC9KDsVLdge5sl+mnShoSsmXY=

VqClygkINsFb33W6zo4tH7fN/xY=

JVojJiGr7UJWMF7x9Y9Wlxv8jpkaQwWvOwfwvQo1h7zzxtYE8NIMgD5mTvk4z5eh

hoHJShgavYAgw9POW0Sq0LHyLFvrXeAwX9banNDTfJg0l6ev9izAl+xsli+pGHXI

8jhwrjzF0hZXwqUwRrM1oybBKdftN+tW0yzxoGGlaWA=


21/305

[email protected]


xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">


22/305

[email protected]


email

[email][email][email][email]

NIFResponsable

[nifResponsable][nifResponsable][nifResponsable][nifResponsable]

fechaNacimiento

[fechaNacimiento][fechaNacimiento][fechaNacimiento][fechaNacimiento]

razonSocial[razonSocial][razonSocial][razonSocial][razonSocial]

clasificacion

[clasificacion][clasificacion][clasificacion][clasificacion]

numeroSerie

[numero de serie del certificado][numero de serie del certificado][numero de serie del certificado][numero de serie del certificado]

[cod_resultado][cod_resultado][cod_resultado][cod_resultado]

[descripcin_resultado][descripcin_resultado][descripcin_resultado][descripcin_resultado]


[des_resultado][des_resultado][des_resultado][des_resultado]

[desc_excepcion][desc_excepcion][desc_excepcion][desc_excepcion]

[cod_estado][cod_estado][cod_estado][cod_estado]

[descripcin_estado][descripcin_estado][descripcin_estado][descripcin_estado]




23/305

[email protected]


[fecha_actualizacion][fecha_actualizacion][fecha_actualizacion][fecha_actualizacion]

[fecha_revocacion][fecha_revocacion][fecha_revocacion][fecha_revocacion]

[motivo_revocacion][motivo_revocacion][motivo_revocacion][motivo_revocacion]

[url_servidor][url_servidor][url_servidor][url_servidor]

[protoc[protoc[protoc[protocolo]olo]olo]olo]



[descripcin_e[descripcin_e[descripcin_e[descripcin_estado]stado]stado]stado][fecha_actualizacion][fecha_actualizacion][fecha_actualizacion][fecha_actualizacion]




[protocolo][protocolo][protocolo][protocolo]



[descripci[descripci[descripci[descripcin_resultado]n_resultado]n_resultado]n_resultado]

[subject][subject][subject][subject]


[descripcin_resultado][descripcin_resultado][descripcin_resultado][descripcin_resultado]

[des[des[des[desc_excepcion]c_excepcion]c_excepcion]c_excepcion]





24/305

[email protected]


[descripcin_e[descripcin_e[descripcin_e[descripcin_estado]stado]stado]stado]

[fecha_actualizacion]




[protocolo][protocolo][protocolo][protocolo]

[cod_excepcion][cod_excepcion][cod_excepcion][cod_excepcion]

Los elementos enumerados en la respuesta se identifican con:

Elemento InfoCertificadoInfoCertificadoInfoCertificadoInfoCertificado: Informacin del certificado validado en caso de haberespecificado en la llamada obtenerInfo a true.

Elemento ResultadoValidacionResultadoValidacionResultadoValidacionResultadoValidacion: Informacin resultado de la validacin del certificadopasado como parmetro.

o Elemento ValidacionSimpleValidacionSimpleValidacionSimpleValidacionSimple: resultado de la validacin de la caducidad, integridady confianza del certificado

o

Elemento ValidacionEstadoValidacionEstadoValidacionEstadoValidacionEstado: resultado de validacin del estado del certificado. Soloser devuelto en caso de realizacin de una validacin compleja (parmetromodoValidacion en el mensaje de entrada es 1).

NNNNota:ota:ota:ota: en la informacin de validacin de estado se ha incluido un nuevo campoinformativo donde, en el caso de utilizar algn mtodo de consulta OCSP, seincluye el OCSP Response recibido del servidor OCSP consultado. De esta forma sedota al cliente de un elemento de confianza adicional que puede ser utilizado parala generacin de firmas y otros procesos que requieran un nivel ms elevado de


25/305

[email protected]


seguridad. El token incluido es la serializacin en bytes convertida a Base64 deuna estructura OCSPResponse, tal y como se define en la RFC 2560.

El token OCSP ser incluido nicamente en todos aquellos mtodos de consultaOCSP que se utilicen para la consulta de estado de un certificado contra undeterminado PSC. En caso de haberse producido cualquier error en la consultaOCSP, el elemento ir vaco en el XML de respuesta.

o Elemento ValidacionCadenaValidacionCadenaValidacionCadenaValidacionCadena: resultado de validacin de la cadena de confianzadel certificado. Solo ser devuelto en caso de realizacin de una validacincompleja (parmetro modoValidacion en el mensaje de entrada es 2).

Los items enumerados en la respuesta se identifican con:

tipo_certificado: Tipo de certificado.

subject: informacin del responsable del certificado.

nombre: Nombre del responsable del certificado.

segundo_apellido: Segundo apellido del responsable del certificado.

primer_apellido: Primer apellido del responsable del certificado.

idEmisor: Identificador del emisor del certificado.

cif: nmero de identificacin de la persona jurdica para certificados de entidad.

email: email del responsable del certificado.

nifResponsable: Nif del responsable del certificado

fechaNacimiento: Fecha de nacimiento de la persona responsable, en caso de e-DNI.

razonSocial: razn social de la persona jurdica.

clasificacion: Clasificacin del certificado en base a su naturaleza. Puede tomar losvalores [0,1,2] con los siguientes criterios:

valor 0. Tipo de certificado para PERSONA FSICA.

valor 1. Tipo de certificado para PERSONA JURDICA.valor 2. Tipo de certificado para COMPONENTES.

En la DPC de la plataforma se detallan los valores asociados a cada tipo de certificadodado de alta en la plataforma @firma.

numeroSerie: nmero de serie del certificado.

cod_resultado: cdigo resultado


26/305

[email protected]


descripcin_resultado: descripcin asociada al cdigo de resultado.

desc_excepcion: item opcional que mostrar la descripcin de la excepcin en caso deproducirse.

cod_estado: cdigo del estado del certificado.

descripcin_estado: descripcin del estado del certificado.

fecha_actualizacion: fecha de ultima actualizacin.

fecha_revocacion: fecha de revocacin del certificado.

motivo_revocacion: motivo de revocacin del certificado.

url_servidor: url del servidor contra el cual se ha producido la verificacin de estado del

certificado. protocolo: protocolo por el cual se ha verificado el estado del certificado.

tokenOCSP: en la informacin de validacin de estado se ha incluido un nuevo campoinformativo donde, en el caso de utilizar algn mtodo de consulta OCSP, se incluye elOCSP Response recibido del servidor OCSP consultado. De esta forma se dota al clientede un elemento de confianza adicional que puede ser utilizado para la generacin defirmas y otros procesos que requieran un nivel ms elevado de seguridad. El tokenincluido es la serializacin en bytes convertida a Base64 de una estructuraOCSPResponse, tal y como se define en la RFC 2560.

El nmero de items y la informacin contenida en el xml de respuesta variar en funcin delcertificado y tipo de certificado a validar.

NOTANOTANOTANOTA: La estructura de campos presentada es la informacin bsica que devuelve la plataforma.Los campos pueden venir en otro orden al marcado en este manual, y por lo tanto lasaplicaciones cliente deben adaptar sus sistemas a tal efecto. Existe la posibilidad por parte de laplataforma @Firma 5.1 de definir e incluir aquellos otros campos que consideren de inters losorganismos y vengan incluidos en los certificados dados de alta en la plataforma. De tal maneraque en un futuro se irn definiendo otras polticas de parseado de campos que se incuirn en losanexos en sucesivas versiones para que estn a disposicin de los organismos interesados.

4.1.4

Mensaje SOAP de respuesta Error.


27/305

[email protected]








ZHJpZDEPMA0GA1UEBxMGTWFkcmlkMQwwCgYDVQQKEwNNQVAxDDAKBgNVBAsTA01B

UDEtMCsGA1UEAxMkcHJlLWFmaXJtYS5yZWRpbnRlcmFkbWluaXN0cmF0aXZhLmVz











28/305

[email protected]





ValidarCertificado1.0

[cod_error][cod_error][cod_error][cod_error]

[descripcion][descripcion][descripcion][descripcion]

[excepcion_asociada][excepcion_asociada][excepcion_asociada][excepcion_asociada]

Los item enumerados en la respuesta se identifican con:


29/305

[email protected]


cod_error: cdigo de error.

descripcion: descripcin del error.

excepcion_asociada: Excepcin que ha provocado el error.

4.2

Mdulo_Validacion. Obtencin de Informacin de Certificado (17/11/2006).

ObtenerInfoCertificado permite extraer la informacin de un certificado mediante la aplicacindel mapeo definido para su tipo. Este proceso verificar que el tipo de certificado se encuentradefinido en la plataforma y que la aplicacin que realiza la peticin tiene acceso a dicho tipo decertificado.

4.2.1

ObtenerInfoCertificado.wsdl


30/305

[email protected]


4.2.2


ObtenerInfoCertificado

1.0



31/305

[email protected]



Certificado: Contenido del certificado a validar codificado en Base 64.

idAplicacion: Identificador de la aplicacin que realiza la peticin.

4.2.3



DQEJARYRc29wb3J0ZS5ydEBtYXAuZXMxCzAJBgNVBAYTAkVTMQ8wDQYDVQQIEwZNYWRyaWQxDzANBgNVBAcTBk1hZHJpZDEMMAoGA1UEChMDTUFQMQwwCgYDVQQLEwNN














32/305

[email protected]








33/305

[email protected]



1.0

tipoCertificado

[tipo_certificado][tipo_certificado][tipo_certificado][tipo_certificado]

subject

[subject][subject][subject][subject]

nombreResponsable

[nombre][nombre][nombre][nombre]

segundoApellidoResponsable

[segundo_apellido][segundo_apellido][segundo_apellido][segundo_apellido]

primerApellidoResponsable

[primer_apellido][primer_apellido][primer_apellido][primer_apellido]

idEmisor

[idEmisor][idEmisor][idEmisor][idEmisor]

NIF-CIF

[cif][cif][cif][cif]

email

[email][email][email][email]


34/305

[email protected]


NIFResponsable

[nifResponsable][nifResponsable][nifResponsable][nifResponsable]

fechaNacimiento

[fechaNacimiento][fechaNacimiento][fechaNacimiento][fechaNacimiento]

razonSocial

[razonSocial][razonSocial][razonSocial][razonSocial]

clasificacion [clasificacion][clasificacion][clasificacion][clasificacion]

numeroSerie

[numero de serie[numero de serie[numero de serie[numero de serie del certificado]del certificado]del certificado]del certificado]


tipo_certificado: Tipo de certificado.

subject: informacin del responsable del certificado.

nombre: Nombre del responsable del certificado.

segundo_apellido: Segundo apellido del responsable del certificado.

primer_apellido: Primer apellido del responsable del certificado.


35/305

[email protected]


idEmisor: Identificador del emisor del certificado.

cif: nmero de identificacin de la persona jurdica para certificados de entidad.

email: email del responsable del certificado.

nifResponsable: Nif del responsable del certificado

fechaNacimiento: Fecha de nacimiento de la persona responsable, en caso de e-DNI.

razonSocial: razn social de la persona jurdica.

clasificacion: Clasificacin del certificado en base a su naturaleza. Puede tomar losvalores [0,1,2] con los siguientes criterios:

valor 0. Tipo de certificado para PERSONA FSICA.

valor 1. Tipo de certificado para PERSONA JURDICA.

valor 2. Tipo de certificado para COMPONENTES.

En la DPC de la plataforma se detallan los valores asociados a cada tipo de certificadodado de alta en la plataforma @firma.

numeroSerie: nmero de serie del certificado.

Debido a que no todos los certificados contienen la misma informacin, la respuesta devueltapor este servicio puede variar de un certificado a otro. En aquellos casos en que un campodeterminado no aplique a un certificado o no se pueda extraer de la informacin contenida en el

mismo, el campo se devolver vaco.

Por otro lado, el nmero de campos o su orden dentro de la respuesta puede variar a lo largo deltiempo. Para evitar errores al interpretar la respuesta, hay que tratar los campos por su nombre yno por su posicin dentro de la respuesta. La lista de todos los campos devueltos para cada tipode certificado se puede consultar en el documento "Anexo Tabla NomenclaturaPSCCERT_Usuarios

4.2.4



36/305

[email protected]


message-security-1.0#Base64Binary" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" wsu:Id="binaryToken">


DQEJARYRc29wb3J0ZS5ydEBtYXAuZXMxCzAJBgNVBAYTAkVTMQ8wDQYDVQQIEwZNYWRyaWQxDzANBgNVBAcTBk1hZHJpZDEMMAoGA1UEChMDTUFQMQwwCgYDVQQLEwNN
















37/305

[email protected]






1.0


[descripcin error][descripcin error][descripcin error][descripcin error]






38/305

[email protected]



4.3

Mdulo_Firma. Validar Firmas (12/07/2006).

ValidarFirma representa el proceso de validar una firma dada, ya sea en formato PKCS7 v1.5,CMS, CAdES, CAdES-BES, CAdES-T, XMLDSignature, XAdES, XAdES-BES o XAdES-T.

4.3.1

ValidarFirma.wsdl


39/305

[email protected]


4.3.2


ValidarFirma

1.0


[formato_firma][formato_firma][formato_firma][formato_firma]

[algoritmo_hash][algoritmo_hash][algoritmo_hash][algoritmo_hash]


40/305

[email protected]



idAplicacion: Identificador de la aplicacin que realiza la peticin. Esta informacinpermitir obtener la poltica asociada para determinar el marco en el que se realizar elproceso requerido.

firma_electronica: Firma electronica a validar codificado en Base 64.

formato_firma: formato de la firma a validar (PKCS7, CMS, CAdES, CAdES-BES,CAdES-T, XMLDSIG, XAdES, XAdES-BES XAdES-T). En caso de no indicarse, sesupondr CMS.

hash: Hash de los datos cuya firma se va a validar, codificado en Base 64. En caso deindicarse, deber indicarse tambin el parmetro algoritmoHash.

algoritmo_hash: Algoritmo de hash con el que se calcul el valor anterior. Slo tienesentido en caso de indicar el valor del hash (parmetro anterior).

datos: Datos cuya firma se va a validar codificado en Base 64.

4.3.3








41/305

[email protected]














JVojJiGr7UJWMF7x9Y9Wlxv8jpkaQwWvOwfwvQo1h7zzxtYE8NIMgD5mTvk4z5ehhoHJShgavYAgw9POW0Sq0LHyLFvrXeAwX9banNDTfJg0l6ev9izAl+xsli+pGHXI



42/305

[email protected]


ValidarFirma

1.0

[estado][estado][estado][estado]

[proceso][proceso][proceso][proceso]

[detalle][detalle][detalle][detalle]

[conclusion][conclusion][conclusion][conclusion]

[certificado][certificado][certificado][certificado]

[sello_tiempo][sello_tiempo][sello_tiempo][sello_tiempo]

[cert_TSA][cert_TSA][cert_TSA][cert_TSA]


43/305

[email protected]



estado: Valor booleano que indica si la operacin ha sido satisfactoria o erronea, true ofalse respectivamente.

proceso: Indica si se ha podido llevar a cabo de forma completa el proceso devalidacin de la firma electrnica.

detalle: Indica el resultado de cada una de las subetapas que se realizan en un procesode validacin de firma electrnica.

conclusion: Indica el resultado final del proceso de validacin de firma electrnica.

Para cada uno de los firmantes contenidos en la firma electrnica:

certificado: Indica el certificado del firmante empleado en la firma electrnica. Este

certificado se incluye formateado en Base64.

sello_tiempo: Time-Stamp del sello de tiempo de la firma electrnica

cert_TSA: Certificado empleado por la TSA para firmar el TimeStampToken de lafirma electrnica.

4.3.4











44/305

[email protected]















45/305

[email protected]


< mensajeSalida xmlns=https://afirmaws/ws/firma xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:SchemaLocation="https://localhost/afirmaws/xsd/mfirma/ws.xsd">

ValidarFirma

1.0

[cod_error][cod_error][cod_error][cod_error][descripcin error][descripcin error][descripcin error][descripcin error]






4.4

Mdulo_Firma. Firma Servidor (21/06/2006).

FirmaServidor representa el proceso de llevar a cabo una firma digital en servidor.

Indicar que este modo de firma se puede considerar como firma delegada, dado que losorganismos indican a la plataforma con qu certificado realizar la Firma Electrnica. Estecertificado se localiza por tanto en plataforma @Firma 5.1 y debe haber sido dado de alta por elorganismo haciendo uso de la Herramienta de Administracin.


46/305

[email protected]


As pues, cada organismo puede tener definidos sus propios certificados para firmas servidor,haciendo uso en la invocacin a este Servicio Web del certificado deseado mediante elparmetro firmante (el cual es el alias dado a dicho certificado mediante la Herramienta de

Administracin).4.4.1

FirmaServidor.wsdl


47/305

[email protected]


4.4.2


FirmaServidor

1.0


[idDocumento][idDocumento][idDocumento][idDocumento]

[firmante][firmante][firmante][firmante]

[idReferencia][idReferencia][idReferencia][idReferencia]




48/305

[email protected]



idAplicacion: Identificador de la aplicacin que realiza la peticin. Esta informacin

permitir obtener la poltica asociada para determinar el marco en el que se realizar elproceso requerido.

idDocumento: Identificador nico del documento a firmar. Se debe haber registradopreviamente mediante las interfaces proporcionadas por el mdulo de Custodia..

firmante: Identificador nico de firmante.

idReferencia: Identificador externo a la plataforma y manejado internamente por laaplicacin. Slo se indica en caso que se necesite por parte de dicha aplicacin.

algoritmo_hash: Indica el algoritmo de hash a emplear en el clculo de la firma. Debeser uno de los asociados con el documento en el momento de registrarlo en la

plataforma (interfaz de Custodia). En caso de no indicarse, se supondr SHA1.

formato_firma: Indica el formato de la firma a generar (PKCS7, CMS). En caso de noindicarse, se supondr CMS.

4.4.3











49/305

[email protected]















50/305

[email protected]


FirmaServidor

1.0



[id_transaccion][id_transaccion][id_transaccion][id_transaccion]




descripcin: Contiene una descripcin del error o excepcin producido en el mdulo.

id_transaccion: Identificador nico de la transaccin generada.

firma_electronica: Firma Electrnica. Est codificada en Base64.

formato_firma: Formato de la firma generada (PKCS7, CMS). Se corresponde con elparmetro formatoFirma de entrada.


51/305

[email protected]


4.4.4


MIICsTCCAhqgAwIBAAIEQ8zySzANBgkqhkiG9w0BAQUFADCBnDEgMB4GCSqGSIb3DQEJARYRc29wb3J0ZS5ydEBtYXAuZXMxCzAJBgNVBAYTAkVTMQ8wDQYDVQQIEwZN
















52/305

[email protected]






FirmaServidor

1.0





53/305

[email protected]






4.5

Mdulo_Firma. Firma Servidor CoSign (21/06/2006).

FirmaServidorCoSign representa el proceso de llevar a cabo una multifirma coSignature enservidor.

4.5.1

FirmaServidorCoSign.wsdl


54/305

[email protected]


4.5.2



55/305

[email protected]


instance" xsi:SchemaLocation="https://localhost/afirmaws/xsd/mfirma/ws.xsd">

FirmaServidorCoSign

1.0


[idTransaccion][idTransaccion][idTransaccion][idTransaccion]





56/305

[email protected]


instance">


















57/305

[email protected]






< FirmaServidorCoSignReturn xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"xsi:type="soapenc:string">

FirmaServidorCoSign

1.0



[id_transaccion][id_transaccion][id_transaccion][id_transaccion]



58/305

[email protected]







formato_firma: Formato de la firma generada (PKCS7, CMS). Se corresponde con el

parmetro formatoFirma de entrada.

4.5.4














59/305

[email protected]












60/305

[email protected]


< mensajeSalida xmlns=https://afirmaws/ws/firma xmlns:xsi="http://www.w3.org/2001/XMLSchema-

instance" xsi:SchemaLocation="https://localhost/afirmaws/xsd/mfirma/ws.xsd">

FirmaServidorCoSign

1.0




Los item enumerados en la respuesta se identifican con: cod_error: cdigo de error.



4.6

Mdulo_Firma. Firma Servidor CounterSign (21/06/2006).

FirmaServidorCounter representa el proceso de llevar a cabo una multifirma counterSignature enservidor.

4.6.1

FirmaServidorCounterSign.wsdl


61/305

[email protected]



62/305

[email protected]


4.6.2


FirmaServidorCounterSign

1.0


[idTransaccion][idTransaccion][idTransaccion][idTransaccion]





idAplicacion: Identificador de la aplicacin que realiza la peticin. Esta informacinpermitir obtener la poltica asociada para determinar el marco en el que se realizar elproceso requerido.


63/305

[email protected]


idTransaccion: Identificador nico de la transaccin de firma sobre la que se deseahacer la multifirma counterSignature. Se debe, por tanto, haber realizado una firma(simple, coSign o counterSign) previamente para haber obtenido dicho identificador de

transaccin. firmante: Identificador nico de firmante.

idReferencia: Identificador externo a la plataforma y manejado internamente por laaplicacin. Slo se indica en caso que se necesite por parte de dicha aplicacin.

algoritmo_hash: Indica el algoritmo de hash a emplear en el clculo de la firma. Debeser uno de los asociados con el documento en el momento de registrarlo en laplataforma (interfaz de Custodia). En caso de no indicarse, se supondr SHA1.

firmante_objetivo: Certificado X509 codificado en base64 del firmante sobre el querealizar la firma counterSign. En caso de no indicarlo, se har una firma counterSign

sobre todos los firmantes localizados en las hojas del rbol de firmantes.

4.6.3







AQkBFhFzb3BvcnRlLnJ0QG1hcC5lczELMAkGA1UEBhMCRVMxDzANBgNVBAgTBk1hZHJpZDEPMA0GA1UEBxMGTWFkcmlkMQwwCgYDVQQKEwNNQVAxDDAKBgNVBAsTA01B







64/305

[email protected]











65/305

[email protected]


soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://soapinterop.org/">

FirmaServidorCounterSign

1.0



[i[i[i[id_transaccion]d_transaccion]d_transaccion]d_transaccion]







formato_firma: Formato de la firma generada (PKCS7, CMS). Se corresponde con elparmetro formatoFirma de entrada.

4.6.4



66/305

[email protected]


MIICsTCCAhqgAwIBAAIE

@Firma Global Xmlsoap Man

Documents