XmerlC14n v0.1.0 XmerlC14n View Source
Elixirification of esaml's Erlang
xmerl_c14n
implementation.
Functions for performing XML canonicalization (c14n), as specified at http://www.w3.org/TR/xml-c14n
These routines work on xmerl
data structures (see the xmerl user
guide for details).
Link to this section Summary
Functions
Given an xmerl
XML tuple (element/attribute/etc...), returns the canonical binary version of the XML it represents.
Given an xmerl
XML tuple (element/attribute/etc...), returns the canonical binary version of the XML it represents.
Link to this section Functions
Given an xmerl
XML tuple (element/attribute/etc...), returns the canonical binary version of the XML it represents.
Returns either {:ok, String.t()}
if canonicalized successfully, or
{:error, {:failed_canonicalization, term}}
if canonicalization failed.
If the preserve_comments
argument is true, preserves comments in the output. Any
namespace prefixes listed in inclusive_namespaces
will be left as they are and not
modified during canonicalization.
# Given xml
<!DOCTYPE doc [<!ATTLIST e9 attr CDATA "default">]>
<doc>
<e1 />
<e2 ></e2>
<e3 name = "elem3" id="elem3" />
<e4 name="elem4" id="elem4" ></e4>
<e5 a:attr="out" b:attr="sorted" attr2="all" attr="I'm"
xmlns:b="http://www.ietf.org"
xmlns:a="http://www.w3.org"
xmlns="http://example.org"/>
<e6 xmlns="" xmlns:a="http://www.w3.org">
<e7 xmlns="http://www.ietf.org">
<e8 xmlns="" xmlns:a="http://www.w3.org">
<e9 xmlns="" xmlns:a="http://www.ietf.org"/>
</e8>
</e7>
</e6>
</doc>
iex> {doc, _} = xml |> to_charlist |> :xmerl_scan.string(namespace_conformant: true, document: true)
iex> {:ok, canonicalized_xml} = XmerlC14n.canonicalize(doc)
iex> IO.puts(canonicalized_xml)
<doc>
<e1></e1>
<e2></e2>
<e3 id="elem3" name="elem3"></e3>
<e4 id="elem4" name="elem4"></e4>
<e5 xmlns="http://example.org" xmlns:a="http://www.w3.org" xmlns:b="http://www.ietf.org" attr="I'm" attr2="all" b:attr="sorted" a:attr="out"></e5>
<e6>
<e7 xmlns="http://www.ietf.org">
<e8 xmlns="">
<e9></e9>
</e8>
</e7>
</e6>
</doc>
canonicalize!(entity)
View Sourcecanonicalize!(entity :: xml_type()) :: String.t()
Given an xmerl
XML tuple (element/attribute/etc...), returns the canonical binary version of the XML it represents.
Returns either String.t()
if canonicalized successfully, or raises an
ArgumentError
if canonicalization failed.
If the preserve_comments
argument is true, preserves comments in the output. Any
namespace prefixes listed in inclusive_namespaces
will be left as they are and not
modified during canonicalization.
# Given xml
<!DOCTYPE doc [<!ATTLIST e9 attr CDATA "default">]>
<doc>
<e1 />
<e2 ></e2>
<e3 name = "elem3" id="elem3" />
<e4 name="elem4" id="elem4" ></e4>
<e5 a:attr="out" b:attr="sorted" attr2="all" attr="I'm"
xmlns:b="http://www.ietf.org"
xmlns:a="http://www.w3.org"
xmlns="http://example.org"/>
<e6 xmlns="" xmlns:a="http://www.w3.org">
<e7 xmlns="http://www.ietf.org">
<e8 xmlns="" xmlns:a="http://www.w3.org">
<e9 xmlns="" xmlns:a="http://www.ietf.org"/>
</e8>
</e7>
</e6>
</doc>
iex> {doc, _} = xml |> to_charlist |> :xmerl_scan.string(namespace_conformant: true, document: true)
iex> XmerlC14n.canonicalize!(doc) |> IO.puts
<doc>
<e1></e1>
<e2></e2>
<e3 id="elem3" name="elem3"></e3>
<e4 id="elem4" name="elem4"></e4>
<e5 xmlns="http://example.org" xmlns:a="http://www.w3.org" xmlns:b="http://www.ietf.org" attr="I'm" attr2="all" b:attr="sorted" a:attr="out"></e5>
<e6>
<e7 xmlns="http://www.ietf.org">
<e8 xmlns="">
<e9></e9>
</e8>
</e7>
</e6>
</doc>