Python Zeep.Client SOAP Request con Header custom-adicional

willy_chaos #1 Jun '19

Hola a todos, estoy peleándome con el cliente SOAP desde Python y me encuentro con que no consigo generar correctamente el XML que se envía.

Os pongo un ejemplo de código que se debería generar (el correcto extraído del SOAP UI, obviamente cambiando los datos de credenciales)

Peticion SOAP UI

POST /soa/extern/SOAP12/MDMCodisProjectes/v01_00 HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/soap+xml;charset=UTF-8;action="http://services.dev.midominio.edu/soa/servei/CodisProjectesMDM/v01_00/consultarCodiProjecteMDMInput"
Content-Length: 1811
Host: services.dev.midominio.edu
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v01="http://midominio.edu/soa/esquema/ElementsComunsMDM/v01_00" xmlns:v011="http://midominio.edu/soa/esquema/ElementsComuns/v01_01" xmlns:v012="http://midominio.edu/soa/servei/MDMCodisProjectes/v01_00">
	<soap:Header>
		<wsse:Security soap:mustUnderstand="true" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
			<wsse:UsernameToken wsu:Id="UsernameToken-6e6f6d657365617363757472656e6f6F">
				<wsse:Username>developer_user</wsse:Username>
				<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">miPasswordEnTextoPlano</wsse:Password>
				<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">rndomDataHash+rndomtxt==</wsse:Nonce>
				<wsu:Created>2019-06-05T08:20:45.644Z</wsu:Created>
			</wsse:UsernameToken>
		</wsse:Security>
		<v01:headerMDMPeticio>
			<v01:idSistemaOrigen>1</v01:idSistemaOrigen>
			<v01:headerMidominio>
				<v011:usuariConnectat>usuarioPlataforma</v011:usuariConnectat>
				<v011:rolUsuariConnectat>pepitoPalote</v011:rolUsuariConnectat>
			</v01:headerMidominio>
		</v01:headerMDMPeticio>
	</soap:Header>
   <soap:Body>
      <v012:consultarCodiProjecteMDMInput>
         <v012:idMDM>100045976</v012:idMDM>
         <v012:usosDada>
            <v01:arrayUsosDeDadaItem>
               <v01:tipus>Prova persona</v01:tipus>
            </v01:arrayUsosDeDadaItem>
         </v012:usosDada>
      </v012:consultarCodiProjecteMDMInput>
   </soap:Body>
</soap:Envelope

Codigo en Python (Django) que genera la peticion SOAP

Codigo Python

from django.shortcuts import render
from django.utils import timezone
from django.conf import settings
from django.contrib.auth.mixins import LoginRequiredMixin,PermissionRequiredMixin
from django.views.generic import ListView, DetailView, CreateView, UpdateView, DeleteView, TemplateView, FormView
from zeep import Client, xsd
from zeep.wsse.username import UsernameToken
from lxml import etree
from .models import MDMRelCodiProjecte

def codiprojecte_list(request):
    codis = MDMRelCodiProjecte.objects.filter(data_esborrat__isnull=True).order_by('data_modificat')
    #Consultamos al servicio SOAP
    url_service = "https://services.dev.midominio.edu/soa/extern/SOAP12/MDMCodisProjectes/v01_00"
    url_wsdl    = url_service+"/?wsdl"

soapClient = Client(url_wsdl,wsse=UsernameToken('developer_user','miPasswordEnTextoPlano'))
soapClient.service._binding_options['address'] = url_service # En el WSDL viene con una URL incorrecta --> ponemos la correcta!

id_service = '100045976'
soapDataUserPass = {'Username':'developer_user','Password':'miPasswordEnTextoPlano'}

node = soapClient.create_message(soapClient.service, 'consultarCodiProjecteMDM',id_service)
print (node)
print (etree.tostring(node,pretty_print=True))

#print(soapClient.service.consultarCodiProjecteMDM(id_service,soapDataUsosDada))
return render(request, 'codi_projecte/codiprojecte_list.html', {'codis':codis})

XML Generado por Python

<soap-env:Envelope xmlns:soap-env="http://www.w3.org/2003/05/soap-envelope">
	<soap-env:Header>
		<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
			<wsse:UsernameToken>
				<wsse:Username>developer_user</wsse:Username>
				<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">miPasswordEnTextoPlano</wsse:Password>
			</wsse:UsernameToken>
		</wsse:Security>
	</soap-env:Header>
	<soap-env:Body>
		<ns0:consultarCodiProjecteMDMInput xmlns:ns0="https://services.dev.midominio.edu/soa/servei/MDMCodisProjectes/v01_00">
			<ns0:idMDM>100045976</ns0:idMDM>
		</ns0:consultarCodiProjecteMDMInput>
	</soap-env:Body>
</soap-env:Envelope>

Estoy mirandome el PDF https://buildmedia.readthedocs.org/media/pdf/python-zeep/master/python-zeep.pdf donde en la pagina 18 indica lo siguiente

from zeep import xsd
header = xsd.Element(
 '{http://test.python-zeep.org}auth',xsd.ComplexType([
  xsd.Element(
  '{http://test.python-zeep.org}username',
  xsd.String()),
  ])
)
header_value = header(username='mvantellingen')
client.service.Method(_soapheaders=[header_value])

pero no termino de ver exactamente como he de poner los datos para que se traduzca al XML que debería ser, ayer intente hacer una prueba pero nanai.

Añadir en el header el formato correcto del UsernameToken y la cabecera headerMDMPeticio con todo el contenido dentro.
Añadir en el body el usosDada con todo su contenido.

Si le hago una petición a saco, metiendo todo el XML en una String y poniendo los valores que me interesan, funciona. Pero claro la idea es usar zeep para generar las peticiones.

willy_chaos #2 Jun '19

nadie??? joer no me creo que ningun developer de MV no se haya tenido que pelear con SOAP

B

[Borrado] #3 Jun '19

nunca he usado python para hacer peticiones soap.

tampoco nunca he creado cabeceras personalizadas.

por cierto, felicidades al campeón que ha echo ese wsdl. Como que no tiene mucho sentido esas cabeceras? usuariConnectat si es el mismo que Username, sobra totalmente, y sino ese nombre es muy malo. El rolUsuariConnectat lo mismo, qué sentido tiene que tú especifiques el rol? Me puedo poner admin así como así? Los roles deberían de estar mapeados en el servidor, invisibles para el cliente.

Jo programo en català, programo sense vergonya.

ésto no funciona

id_service = '100045976'
soapDataUserPass = {'Username':'developer_user','Password':'miPasswordEnTextoPlano'}
print(soapClient.service.consultarCodiProjecteMDM(id_service,soapDataUsosDada))

porque le tienes que pasar la estructura correctamente digo yo, tal como lo indica en el ejemplo + el body

1 respuesta

willy_chaos #4 Jun '19

#3 respecto a lo de catalán... enfin...

no soy quien ha hecho el wsdl pero aun asi, que mas da? si el campo se llama usuariConnectat o se llama usuarioConectado

respecto a las cabeceras custom, pues he intentado cosillas tal como indica el pdf , pero nade de nada :/ y son obligatorias de enviar.

En otros lenguajes si envío la petición en RAW, funciona, pero claro tengo que gestionar yo el parsing de XML para saber si ha habido error o no, y quiero evitarme todo eso...

Simplemente me falta esto, pero bueno seguiré peleandome con ello a ver si lo saco . no creo que sea el primero al que le pasa...

1 respuesta

B

[Borrado] #5 Jun '19

es cuestión de saber cómo construir los headers y hacer bien la llamada

mirate la respuesta de éste: https://stackoverflow.com/questions/42963114/python-zeep-soap-complex-header

#4willy_chaos:
no soy quien ha hecho el wsdl pero aun asi, que mas da? si el campo se llama usuariConnectat o se llama usuarioConectado

estaba puntualizando el mal diseño del wsdl, o a ti no te sorprende que hayan dos campos que sirvan para lo mismo?? y con un nombre mejor no me refiero que este en castellano, sino que describa bien su verdadera función. Pero vamos, que tampoco te toca a ti cambiarlo, pero sí deberías de criticarlo y hacerlo saber a tus superiores

1 respuesta

willy_chaos #6 Jun '19

#5 Ese link que has pasado de Stackoverflow es lo que estuve probando y la verdad o no he sabido hacerlo (ya ves tu, es seguir los pasos...) , pero no me ha funcionado :/, aun así, este martes volveré a intentarlo.

#5oldFox-64:
que hayan dos campos que sirvan para lo mismo??

Realmente no sirven para lo mismo.

El usuario y password es quien tiene definidos realmente los permisos para llamar (crear, actualizar, eliminar, listar) al Service.

El usuariConnectat es mas bien porque esto va a ser integrado en una Intranet, y lo que se quiere, es saber quien ha realizado la petición desde la intranet, y el rol que tenia seleccionado dentro de la intranet (como digo, es a modo meramente informativo) puesto quien tiene permisos para hacer llamadas a ciertos ¿endpoint? es el username.

Solo que yo al copiar aqui la peticion XML o el codigo Python, he puesto en ambos campos el mismo usuario (para ahorrar tiempo)

willy_chaos #7 Jun '19

Bueno voy haciendo avances, aunque algo dummies pero me van sirviendo. Así que lo voy poniendo aquí para si alguien se encuentra en la misma situación. Para crear las cabeceras he hecho uso del siguiente código

header = xsd.Element(
  'headerMDMPeticio',xsd.ComplexType([
		xsd.Element('idSistemaOrigen',xsd.String()),
		xsd.Element(
			'headerMidominio',xsd.ComplexType([
				xsd.Element('usuariConnectat',xsd.String()),
				xsd.Element('rolUsuariConnectat',xsd.String())
			])
		)
	])
)
#Bindeamos los datos a la cabecera
header_value = header(idSistemaOrigen='1',headerMidominio={'usuariConnectat':'usuarioIntranet','rolUsuariConnectat':'rolIntranet'})

Con esto ya se genera bien la cabecera, pero no se generaban en el UsernameToken los campos Nonce, y Created, así que antes de realizar la creacion del Client hice lo siguiente:

usernameToken = UsernameToken('usuarioOSB','miPasswordEnTextoPlano')
usernameToken.use_digest=True
soapClient = Client(url_wsdl,wsse=usernameToken)

Finalmente para realizar la llamada hago uso

response = soapClient.service.consultarCodiProjecteMDM( _soapheaders=[header_value],idMDM=id_service )

Ahora unicamente se me queja de que los headers que he añadido han de ser "Qualified" vease, han de contener el v01:headerMDMPeticio con lo cual me estoy peleando.

Python Zeep.Client SOAP Request con Header custom-adicional

Usuarios habituales

Tags