Skip to content

Commit

Permalink
Switch to v2 security
Browse files Browse the repository at this point in the history
  • Loading branch information
wrygiel committed Aug 9, 2017
1 parent d07bfc4 commit 3c42315
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 3 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ This document describes all the changes made to the *Outgoing Mobilities API*
document, starting from its first beta draft version.


0.9.0
-----

* This API now requires implementers to upgrade their implementations to
[Version 2](https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2)
of the *Authentication and Security* document.

In particular, this means that the clients MUST be aware of the fact, that
the server is no longer required to support methods of authentication and
encryption which it *was* required to support in the previous versions of
this API. Clients SHOULD consult the newly introduced `<http-security>`
element in the server's manifest entry before making their requests.


0.8.1
-----

Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,15 @@ though.
Security
--------

For all endpoints of this API, implementers MUST follow the rules described in
[EWP Authentication and Security, Version 1][sec-v1] document.
This version of this API uses [standard EWP Authentication and Security,
Version 2][sec-v2]. Server implementers choose which security methods they
support by declaring them in their Manifest API entry.

This API handles data which is considered private. Server implementers are
allowed to forbid less-secure methods of authentication and encryption for this
API (by dropping support for them). Currently, we leave it for the server
implementers to decide which methods are "secure enough". These recommendations
MAY change in the future.


Endpoints to be implemented
Expand Down Expand Up @@ -75,4 +82,4 @@ Data model entities involved in the response
[echo]: https://github.com/erasmus-without-paper/ewp-specs-api-echo
[error-handling]: https://github.com/erasmus-without-paper/ewp-specs-architecture#error-handling
[institutions-api]: https://github.com/erasmus-without-paper/ewp-specs-api-institutions
[sec-v1]: https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v1
[sec-v2]: https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2
20 changes: 20 additions & 0 deletions manifest-entry.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
xmlns:ewp="https://github.com/erasmus-without-paper/ewp-specs-architecture/blob/stable-v1/common-types.xsd"
xmlns:sec="https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2"
elementFormDefault="qualified"

targetNamespace="https://github.com/erasmus-without-paper/ewp-specs-api-mobilities/blob/stable-v1/manifest-entry.xsd"
Expand All @@ -15,6 +16,11 @@
namespace="https://github.com/erasmus-without-paper/ewp-specs-architecture/blob/stable-v1/common-types.xsd"
/>

<xs:import
schemaLocation="https://raw.githubusercontent.com/erasmus-without-paper/ewp-specs-sec-intro/stable-v2/schema.xsd"
namespace="https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2"
/>

<xs:annotation>
<xs:documentation>
This schema is a part of the Erasmus Without Paper project. Before you start
Expand All @@ -37,6 +43,20 @@
<xs:complexContent>
<xs:extension base="ewp:ManifestApiEntryBase">
<xs:sequence>
<xs:element name="http-security" type="sec:HttpSecurityOptions" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Describes which security policies the server supports for this API. If not
given, then the server states that it supports the default set of security
policies (as described in the annotations in sec:HttpSecurityOptions).

The policies described in this element apply to all endpoints of this API (the
`*-url` elements below). Clients SHOULD consult this element before accessing
any of these endpoints (otherwise, their request might be rejected by the
server).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="get-url" type="ewp:HTTPS" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Expand Down

0 comments on commit 3c42315

Please sign in to comment.