From 6cdbce0f3a571ee7885d9403c6661ffdad8363d7 Mon Sep 17 00:00:00 2001 From: handnot2 Date: Sat, 4 Nov 2017 14:34:13 -0700 Subject: [PATCH] turn of some of the module docs --- lib/samly/config_error.ex | 2 ++ lib/samly/idp_data.ex | 2 ++ lib/samly/provider.ex | 37 +------------------------------------ lib/samly/sp_data.ex | 2 ++ mix.lock | 20 ++++++++++---------- 5 files changed, 17 insertions(+), 46 deletions(-) diff --git a/lib/samly/config_error.ex b/lib/samly/config_error.ex index 1305fae..b50ca96 100644 --- a/lib/samly/config_error.ex +++ b/lib/samly/config_error.ex @@ -1,4 +1,6 @@ defmodule Samly.ConfigError do + @moduledoc false + defexception [:message] @spec exception(map) :: Exception.t diff --git a/lib/samly/idp_data.ex b/lib/samly/idp_data.ex index 7069bf0..92d8421 100644 --- a/lib/samly/idp_data.ex +++ b/lib/samly/idp_data.ex @@ -1,4 +1,6 @@ defmodule Samly.IdpData do + @moduledoc false + require Logger alias Samly.IdpData alias Samly.SpData diff --git a/lib/samly/provider.ex b/lib/samly/provider.ex index 48ebd72..90a3a14 100644 --- a/lib/samly/provider.ex +++ b/lib/samly/provider.ex @@ -15,42 +15,7 @@ defmodule Samly.Provider do ] ``` - The configuration parameters are honored in the following order: `Application.get_env`, - environment variables and finally hard defaultds. - - The configuration information needed for `Samly` can be specified as shown here: - - ```elixir - # config/dev.exs - # TODO: Update this - - config :samly, Samly.Provider, - base_url: "http://samly.howto:4003/sso", - #entity_id: "urn:myapp-host:my-id", - #pre_session_create_pipeline: MySamlyPipeline, - #use_redirect_for_idp_req: false, - #sign_requests: true, - #sign_metadata: true, - #signed_envelopes_in_idp_resp: true, - #signed_assertion_in_idp_resp: true, - certfile: "path/to/service/provider/certificate/file", - keyfile: "path/to/corresponding/private/key/file", - idp_metadata_file: "path/to/idp/metadata/xml/file" - ``` - - `Samly` relies on environment variables for parameters missing from configuration. - - | Variable | Description | - |:-------------------- |:-------------------- | - | SAMLY_CERTFILE | Path to the X509 certificate file. Defaults to `samly.crt` | - | SAMLY_KEYFILE | Path to the private key for the certificate. Defaults to `samly.pem` | - | SAMLY_IDP_METADATA_FILE | Path to the SAML IDP metadata XML file. Defaults to `idp_metadata.xml` | - | SAMLY_BASE_URL | Set this to the base URL for your application (include `/sso`) | - | SAMLY_SIGN_REQUESTS | Set this to `false` if IdP is setup to receive unsigned requests | - | SAMLY_SIGN_METADATA | Set this to `false` if the metadata response should be unsigned | - | SAMLY_SIGNED_ENVELOPES_IN_IDP_RESP | Set this to `false` if IdP is sending unsigned response | - | SAMLY_SIGNED_ASSERTION_IN_IDP_RESP | Set this to `false` if IdP is sending unsigned response | - + Check README.md `Configuration` section. """ use GenServer diff --git a/lib/samly/sp_data.ex b/lib/samly/sp_data.ex index b733e94..275ed93 100644 --- a/lib/samly/sp_data.ex +++ b/lib/samly/sp_data.ex @@ -1,4 +1,6 @@ defmodule Samly.SpData do + @moduledoc false + require Logger alias Samly.ConfigError diff --git a/mix.lock b/mix.lock index 41dec00..09818cc 100644 --- a/mix.lock +++ b/mix.lock @@ -1,10 +1,10 @@ -%{"cowboy": {:hex, :cowboy, "1.1.2", "61ac29ea970389a88eca5a65601460162d370a70018afe6f949a29dca91f3bb0", [:rebar3], [{:cowlib, "~> 1.0.2", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.3.2", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"}, - "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], [], "hexpm"}, - "earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [:mix], [], "hexpm"}, - "esaml": {:hex, :esaml, "3.1.0", "76337f00b5953a6c249fa8c322905c7a069b7c20339ece3756072279e6dcb41c", [:rebar3], [{:cowboy, "1.1.2", [hex: :cowboy, repo: "hexpm", optional: false]}], "hexpm"}, - "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"}, - "inch_ex": {:hex, :inch_ex, "0.5.6", "418357418a553baa6d04eccd1b44171936817db61f4c0840112b420b8e378e67", [:mix], [{:poison, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"}, - "mime": {:hex, :mime, "1.1.0", "01c1d6f4083d8aa5c7b8c246ade95139620ef8effb009edde934e0ec3b28090a", [:mix], [], "hexpm"}, - "plug": {:hex, :plug, "1.4.3", "236d77ce7bf3e3a2668dc0d32a9b6f1f9b1f05361019946aae49874904be4aed", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"}, - "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"}, - "ranch": {:hex, :ranch, "1.3.2", "e4965a144dc9fbe70e5c077c65e73c57165416a901bd02ea899cfd95aa890986", [:rebar3], [], "hexpm"}} +%{"cowboy": {:hex, :cowboy, "1.1.2", "61ac29ea970389a88eca5a65601460162d370a70018afe6f949a29dca91f3bb0", [], [{:cowlib, "~> 1.0.2", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.3.2", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"}, + "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [], [], "hexpm"}, + "earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [], [], "hexpm"}, + "esaml": {:hex, :esaml, "3.1.0", "76337f00b5953a6c249fa8c322905c7a069b7c20339ece3756072279e6dcb41c", [], [{:cowboy, "1.1.2", [hex: :cowboy, repo: "hexpm", optional: false]}], "hexpm"}, + "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"}, + "inch_ex": {:hex, :inch_ex, "0.5.6", "418357418a553baa6d04eccd1b44171936817db61f4c0840112b420b8e378e67", [], [{:poison, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"}, + "mime": {:hex, :mime, "1.1.0", "01c1d6f4083d8aa5c7b8c246ade95139620ef8effb009edde934e0ec3b28090a", [], [], "hexpm"}, + "plug": {:hex, :plug, "1.4.3", "236d77ce7bf3e3a2668dc0d32a9b6f1f9b1f05361019946aae49874904be4aed", [], [{:cowboy, "~> 1.0.1 or ~> 1.1", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"}, + "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [], [], "hexpm"}, + "ranch": {:hex, :ranch, "1.3.2", "e4965a144dc9fbe70e5c077c65e73c57165416a901bd02ea899cfd95aa890986", [], [], "hexpm"}}