Module exmpp_client_sasl

Function Index
Function Details

Authors: Jean-SÃ©bastien PÃ©dron (js.pedron@meetic-corp.com).

Function Index

abort/0	Make a `<abort/>` element.
announced_mechanisms/1	Return the list of SASL mechanisms announced by the receiving entity.
next_step/1	Extract the challenge or the ending element that the receiving entity sent.
response/1	Prepare a `<response/>` element to send the challenge's response.
selected_mechanism/1	Prepare an `<auth/>` element with the selected mechanism.
selected_mechanism/2	Prepare an `<auth/>` element with the selected mechanism.

Function Details

abort/0

abort() -> Abort

Abort = exmpp_xml:xmlel()

Make a <abort/> element.

announced_mechanisms/1

announced_mechanisms(Xmlel::Features_Announcement) -> Mechanisms

Features_Announcement = exmpp_xml:xmlel()
Mechanisms = [string()]

throws {sasl, announced_mechanisms, invalid_feature, Feature} | {sasl, announced_mechanisms, invalid_mechanism, El}

Return the list of SASL mechanisms announced by the receiving entity.

next_step/1

next_step(Xmlel::El) -> Type

El = exmpp_xml:xmlel()
Type = Challenge | Success | Failure
Challenge = {challenge, string()}
Success = {success, string()}
Failure = {failure, Condition | undefined}
Condition = atom()

Extract the challenge or the ending element that the receiving entity sent.

Any challenge or success data is Base64-decoded.

response/1

response(Response_Data) -> Response

Response_Data = string()
Response = exmpp_xml:xmlel()

Prepare a <response/> element to send the challenge's response.

Response_Data will be Base64-encoded.

selected_mechanism/1

selected_mechanism(Mechanism) -> Auth

Mechanism = string()
Auth = exmpp_xml:xmlel()

Prepare an <auth/> element with the selected mechanism.

selected_mechanism/2

selected_mechanism(Mechanism, Initial_Response) -> Auth

Mechanism = string()
Initial_Response = string()
Auth = exmpp_xml:xmlel()

Prepare an <auth/> element with the selected mechanism.

The initial response will be Base64-encoded before inclusion.

Generated by EDoc, Feb 19 2012, 12:53:53.