Skip to content

Commit

Permalink
Merge branch 'master' of github.com:frogeducation/example-3rd-party-a…
Browse files Browse the repository at this point in the history
…pp-authentication
  • Loading branch information
Tom Chapman authored and Tom Chapman committed Dec 9, 2015
2 parents a1cbeec + 7aad21c commit c1f467c
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 9 deletions.
27 changes: 27 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
BSD 3-Clause License

Copyright (c) 2015 Frog Education Ltd

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions
and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials provided with
the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To install using composer you need to do the following:
`cp config-templates/{config,authsources}.php config/`
`cp metadata-templates/saml20-idp-remote.php metadata/`
`cd ../../../www`
`ln -s ../vendor/simplesamlphp/simplesamlphp/www .`
`ln -s ../vendor/simplesamlphp/simplesamlphp/www saml`

[2]: https://getcomposer.org/

Expand Down Expand Up @@ -73,10 +73,10 @@ The next step is to configure SimpleSAMLPHP. We have provided example configurat
Further documentation on the SimpleSAMLPHP config file can be found [here][4]

The two other files you need are `simplesamlphp/config/authsources.php` and `simplesamlphp/metadata/saml20-idp-remote.php`.
The examples provided under `frog-federation/config/authsources.php` and `frog-federation/metadata/saml20-sp-remote.php` will work with the development federation provided by frog (mentioned later).
The examples provided under `frog-federation/config/authsources.php` and `frog-federation/metadata/saml20-idp-remote.php` will work with the development federation provided by frog (mentioned later).
To use these simply run the following:
`cp frog-federation/config/authsources.php simplesamlphp/config/authsources.php`
`cp frog-federation/metadata/saml20-sp-remote.php simplesamlphp/metadata/saml20-idp-remote.php`
`cp frog-federation/metadata/saml20-idp-remote.php simplesamlphp/metadata/saml20-idp-remote.php`

***Please Note***: The authsources.php and saml20-idp-remote.php provided are for development against the frog **development** federation. When configuring your application against the production federation these will require changes. Please contact the Partners support team at FrogEducation to acquire these and setup your application against the production federation.

Expand All @@ -91,11 +91,12 @@ So that your app will work with the Frog Development Federation you will need to

Testing The App
===============
We have three boxes setup for you to develop against:
We have four boxes setup for you to develop against:

Development Frog Federation: [https://federation-misc.frogosdev.co.uk/][5]
Example Secondary School: [https://secondaryexternal-misc.frogosdev.co.uk/][6]
Example Primary School: [https://primaryexternal-misc.frogosdev.co.uk/][7]
Example Secondary School: [https://secondaryexternal-misc.frogtest.co.uk/][6]
Example Primary School: [https://primaryexternal-misc.frogtest.co.uk/][7]
Development Frog Identity: [https://frogidentity-misc.frogosdev.co.uk/][8]

In your browser go to: https://your-domain.com/
Provided a correct server software setup this should run the provided index.php and re-direct you to a discovery page on [https://federation-misc.frogosdev.co.uk/][5] which will look like the following:
Expand Down Expand Up @@ -131,5 +132,6 @@ When using these accounts, you will be presented with a screen upon first login
![Attribute Agreement](readme-images/federation-attribute-agreement.png?raw=true "Attribute Agreement")

[5]: https://federation-misc.frogosdev.co.uk/
[6]: https://secondaryexternal-misc.frogosdev.co.uk/
[7]: https://primaryexternal-misc.frogosdev.co.uk/
[6]: https://secondaryexternal-misc.frogtest.co.uk/
[7]: https://primaryexternal-misc.frogtest.co.uk/
[8]: https://frogidentity-misc.frogosdev.co.uk/
2 changes: 1 addition & 1 deletion setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ mkdir {config,metadata}
cp config-templates/{config,authsources}.php config/
cp metadata-templates/saml20-idp-remote.php metadata/
cd ../../../www
ln -s ../vendor/simplesamlphp/simplesamlphp/www .
ln -s ../vendor/simplesamlphp/simplesamlphp/www saml

0 comments on commit c1f467c

Please sign in to comment.