SmeeFeds (SmeeFeds v0.1.1) View Source
SmeeFeds
is a small federation management extension to Smee for use
in research, testing and development.
Smee has tools for handling the sources of SAML metadata but nothing to represent the publishers of metadata. SmeeFeds adds a few tools for handling federations and includes a large collection of information about research and education federations.
Features
- Easily find information about major federations
- Filter and group federations by location or EU membership
- Use federation records directly with Smee to download metadata from aggregates or MDQ servers
- Export lists of federation information as CSV, JSON or Markdown documents
The top level SmeeFeds
module has tools for selecting individual federation details or lists of many at once.
SmeeFeds contain more tools for handling federations, such as:
SmeeFeds.Federation
- tools for accessing data such as metadata download URLs, contacts, homepages, and so on.SmeeFeds.Export
- convert lists of federations into data for export, or simple text reportsSmeeFeds.Filter
- filter lists of federations by various criteria
IMPORTANT DISCLAIMER AND WARNING
SmeeFeds comes with a built-in list of federations, using information gathered from various sources on the Internet.
This collection of information is for use by researchers, developers and testers.
IT IS NOT FOR USE IN PRODUCTION ENVIRONMENTS
Metadata is the bedrock of trust and information security in SAML federations. DO NOT use metadata URLs, certificates and certificate fingerprints to download and use metadata in live services without confirming each detail yourself.
If you must use SmeeFeds as part of a production service, then after information has been verified you can export only
the verified information you need as a JSON file and set it as the new default using
:smee_feds, :data_file
config setting in your application.
There is absolutely no guarantee or warranty that the data in SmeeFeds is correct, and it is not supported by any of the federations listed. It's totally unofficial.
Link to this section Summary
Functions
Lists all countries in the provided list of federations (or the default set if no federations are passed)
Finds a federation in the default database by ID and returns the full federation record.
Returns a list of SmeeFeds.Federation
structs.
Returns a list of SmeeFeds.Federation
structs when passed a list of
federation IDs (as atoms).
Finds a federation in the default database by ID and returns the full federation record.
Returns the ids of all federations in the default collection as a list of atoms.
Returns the ids of all federations in the provided list of federations as a list of atoms.
Tries to find the federation that published the provided Smee record (source, entity or metadata)
Is a federation the publisher of the provided Smee Source, Metadata, or Entity?
Lists all regions in the provided list of federations (or the default set if no federations are passed)
Lists all sub_regions in the provided list of federations (or the default set if no federations are passed)
Lists all super_regions in the provided list of federations (or the default set if no federations are passed)
Link to this section Functions
Specs
countries([SmeeFeds.Federation.t()]) :: [struct()]
Lists all countries in the provided list of federations (or the default set if no federations are passed)
Examples
iex> SmeeFeds.countries()
iex> SmeeFeds.federations([:ukamf, :incommon]) |> SmeeFeds.countries()
Specs
federation(federation :: atom() | binary()) :: SmeeFeds.Federation.t() | nil
Finds a federation in the default database by ID and returns the full federation record.
Example
iex> incommon = SmeeFeds.federation(:incommon)
Specs
federations() :: [SmeeFeds.Federation.t()]
Returns a list of SmeeFeds.Federation
structs.
Returns all known federations from the default collection.
Example
iex> federations = SmeeFeds.federations()
Specs
federations(federations :: list()) :: [SmeeFeds.Federation.t()]
Returns a list of SmeeFeds.Federation
structs when passed a list of
federation IDs (as atoms).
Example
iex> federations = SmeeFeds.federations([:ukamf, :ref])
Specs
get(federation :: atom() | binary()) :: SmeeFeds.Federation.t() | nil
Finds a federation in the default database by ID and returns the full federation record.
Example
iex> incommon = SmeeFeds.get(:incommon)
Returns the ids of all federations in the default collection as a list of atoms.
Example
iex> ids = SmeeFeds.ids()
Specs
Returns the ids of all federations in the provided list of federations as a list of atoms.
Example
iex> federations = SmeeFeds.federations([:ukamf, :ref])
iex> ids = SmeeFeds.ids(federations)
Tries to find the federation that published the provided Smee record (source, entity or metadata)
The first matching federation record will be returned if found, or nil if no federations match.
Example
iex> source = Smee.source("http://metadata.ukfederation.org.uk/ukfederation-metadata.xml")
iex> federation = SmeeFeds.publisher(source)
%SmeeFeds.Federation{id: :ukamf} = federation
Specs
publisher?( SmeeFeds.Federation.t(), smee_struct :: Smee.Source.t() | Smee.Metadata.t() | Smee.Entity.t() ) :: boolean()
Is a federation the publisher of the provided Smee Source, Metadata, or Entity?
Returns true if the federation and source, metadata or entity share a URL or publisher URI, false otherwise.
Example
iex> source = Smee.source("http://metadata.ukfederation.org.uk/ukfederation-metadata.xml")
iex> federation = SmeeFeds.get(:ukamf)
iex> SmeeFeds.publisher?(federation, source)
true
Specs
regions([SmeeFeds.Federation.t()]) :: [struct()]
Lists all regions in the provided list of federations (or the default set if no federations are passed)
Examples
iex> SmeeFeds.regions()
iex> SmeeFeds.federations([:ukamf, :incommon]) |> SmeeFeds.regions()
["Americas", "Europe"]
Specs
sub_regions([SmeeFeds.Federation.t()]) :: [struct()]
Lists all sub_regions in the provided list of federations (or the default set if no federations are passed)
Examples
iex> SmeeFeds.sub_regions()
iex> SmeeFeds.federations([:ukamf, :incommon]) |> SmeeFeds.sub_regions()
["Northern America", "Northern Europe"]
Specs
super_regions([SmeeFeds.Federation.t()]) :: [struct()]
Lists all super_regions in the provided list of federations (or the default set if no federations are passed)
Examples
iex> SmeeFeds.super_regions()
iex> SmeeFeds.federations([:ukamf, :incommon]) |> SmeeFeds.super_regions()
["AMER", "EMEA"]