forked from manfredsteyer/angular-oauth2-oidc
-
Notifications
You must be signed in to change notification settings - Fork 1
/
changelog.html
130 lines (98 loc) · 5.3 KB
/
changelog.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-oauth2-oidc</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
<link rel="stylesheet" href="./styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="./" class="navbar-brand">angular-oauth2-oidc</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content getting-started">
<div class="content-data">
<h1 id="change-log">Change Log</h1>
<h2 id="lates-features">Lates features</h2>
<p>See <a href="https://github.com/manfredsteyer/angular-oauth2-oidc/releases">Release Notes</a></p>
<h2 id="new-features-in-version-21">New Features in Version 2.1</h2>
<ul>
<li>New Config API (the original one is still supported)</li>
<li>New convenience methods in OAuthService to streamline default tasks:<ul>
<li><code>setupAutomaticSilentRefresh()</code></li>
<li><code>loadDiscoveryDocumentAndTryLogin()</code></li>
</ul>
</li>
<li>Single Sign out through Session Status Change Notification according to the OpenID Connect Session Management specs. This means, you can be notified when the user logs out using at the login provider.</li>
<li>Possibility to define the ValidationHandler, the Config as well as the OAuthStorage via DI</li>
<li>Better structured documentation</li>
</ul>
<h2 id="new-features-in-version-2">New Features in Version 2</h2>
<ul>
<li>Token Refresh for Implicit Flow by implementing "silent refresh"</li>
<li>Validating the signature of the received id_token</li>
<li>Providing Events via the observable <code>events</code>.</li>
<li>The event <code>token_expires</code> can be used together with a silent refresh to automatically refresh a token when/ before it expires (see also property <code>timeoutFactor</code>).</li>
</ul>
<h2 id="breaking-changes-in-version-2">Breaking Changes in Version 2</h2>
<ul>
<li>The property <code>oidc</code> defaults to <code>true</code>.</li>
<li>If you are just using oauth2, you have to set <code>oidc</code> to <code>false</code>. Otherwise, the validation of the user profile will fail!</li>
<li>By default, <code>sessionStorage</code> is used. To use <code>localStorage</code> call method setStorage</li>
<li>Demands using https as OIDC and OAuth2 relay on it. This rule can be relaxed using the property <code>requireHttps</code>, e. g. for local testing.</li>
<li>Demands that every url provided by the discovery document starts with the issuer's url. This can be relaxed by using the property <code>strictDiscoveryDocumentValidation</code>.</li>
</ul>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 0;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
var COMPODOC_CURRENT_PAGE_URL = 'changelog.html';
</script>
<script src="./js/libs/custom-elements.min.js"></script>
<script src="./js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="./js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="./js/menu-wc.js" defer></script>
<script src="./js/libs/bootstrap-native.js"></script>
<script src="./js/libs/es6-shim.min.js"></script>
<script src="./js/libs/EventDispatcher.js"></script>
<script src="./js/libs/promise.min.js"></script>
<script src="./js/libs/zepto.min.js"></script>
<script src="./js/compodoc.js"></script>
<script src="./js/tabs.js"></script>
<script src="./js/menu.js"></script>
<script src="./js/libs/clipboard.min.js"></script>
<script src="./js/libs/prism.js"></script>
<script src="./js/sourceCode.js"></script>
<script src="./js/search/search.js"></script>
<script src="./js/search/lunr.min.js"></script>
<script src="./js/search/search-lunr.js"></script>
<script src="./js/search/search_index.js"></script>
<script src="./js/lazy-load-graphs.js"></script>
</body>
</html>