Skip to content

Commit

Permalink
Merge pull request #98 from dannys42-contrib/MISC-org_update
Browse files Browse the repository at this point in the history
Misc org update
  • Loading branch information
mbarnach authored Nov 26, 2020
2 parents 77c141b + 6f1424c commit 0166688
Show file tree
Hide file tree
Showing 53 changed files with 876 additions and 692 deletions.
6 changes: 2 additions & 4 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: SwiftJWT
author: IBM
github_url: https://github.com/IBM-Swift/Swift-JWT/
author: IBM & Kitura Project Contributors
github_url: https://github.com/Kitura/Swift-JWT/

theme: fullwidth
clean: true
Expand All @@ -10,5 +10,3 @@ readme: README.md

skip_undocumented: false
hide_documentation_coverage: false

xcodebuild_arguments: [-project, SwiftJWT.xcodeproj, -target, SwiftJWT, LIBRARY_SEARCH_PATHS=.build/debug]
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ matrix:
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT

before_install:
- git clone https://github.com/IBM-Swift/Package-Builder.git
- git clone https://github.com/Kitura/Package-Builder.git

script:
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<p align="center">
<a href="http://kitura.io/">
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>


<p align="center">
<a href="https://ibm-swift.github.io/Swift-JWT/index.html">
<a href="https://kitura.github.io/Swift-JWT/index.html">
<img src="https://img.shields.io/badge/apidoc-SwiftJWT-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/IBM-Swift/Swift-JWT">
<img src="https://travis-ci.org/IBM-Swift/Swift-JWT.svg?branch=master" alt="Build Status - Master">
<a href="https://travis-ci.org/Kitura/Swift-JWT">
<img src="https://travis-ci.org/Kitura/Swift-JWT.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
Expand All @@ -36,9 +36,9 @@ The latest version of Swift-JWT requires **Swift 4.0** or later. You can downloa
### Swift Package Manager

#### Add dependencies
Add the `Swift-JWT` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `Swift-JWT` [release](https://github.com/IBM-Swift/Swift-JWT/releases).
Add the `Swift-JWT` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `Swift-JWT` [release](https://github.com/Kitura/Swift-JWT/releases).
```swift
.package(url: "https://github.com/IBM-Swift/Swift-JWT.git", from: "x.x.x")
.package(url: "https://github.com/Kitura/Swift-JWT.git", from: "x.x.x")
```
Add `SwiftJWT` to your target's dependencies:
```swift
Expand Down Expand Up @@ -126,7 +126,7 @@ let publicKeyPath = URL(fileURLWithPath: getAbsolutePath(relativePath: "/path/to
let publicKey: Data = try Data(contentsOf: publicKeyPath, options: .alwaysMapped)
```

For details on creating elliptic curve public and private keys, view the [BlueECC README.txt](https://github.com/IBM-Swift/BlueECC).
For details on creating elliptic curve public and private keys, view the [BlueECC README.txt](https://github.com/Kitura/BlueECC).

#### Sign a JWT using a JWTSigner

Expand Down Expand Up @@ -225,7 +225,7 @@ The JWTEncoder and JWTDecoder classes encode and decode JWT Strings using the sa
let jwt = try jwtDecoder.decode(JWT<MyClaims>.self, fromString: jwtString)
```

Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/Contracts.swift) BodyEncoder and BodyDecoder protocols, they can be used as a [custom coder](https://developer.ibm.com/swift/2018/09/01/kitura-custom-encoders-and-decoders/) in Codable routes for sending and receiving JWTs:
Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/Contracts.swift) BodyEncoder and BodyDecoder protocols, they can be used as a [custom coder](https://developer.ibm.com/swift/2018/09/01/kitura-custom-encoders-and-decoders/) in Codable routes for sending and receiving JWTs:

```swift
router.encoders[MediaType(type: .application, subType: "jwt")] = { return jwtEncoder }
Expand All @@ -235,11 +235,11 @@ Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.c
This allows for the use of JWT's in information exchange. By sending and receiving JWT's you can ensure the sending is who they say they are and verify the content hasn't been tampered with.

## API Documentation
For more information visit our [API reference](https://ibm-swift.github.io/Swift-JWT/index.html).
For more information visit our [API reference](https://kitura.github.io/Swift-JWT/index.html).

## Community

We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!

## License
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/IBM-Swift/Swift-JWT/blob/master/LICENSE).
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/Swift-JWT/blob/master/LICENSE).
34 changes: 15 additions & 19 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
SwiftJWT Docs
SwiftJWT 3.6.200 Docs
</a>
(100% documented)
</p>
Expand All @@ -33,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -109,7 +109,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

Expand Down Expand Up @@ -148,10 +148,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -180,10 +176,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -218,9 +210,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/JWTEncoder"></a>
<a name="//apple_ref/swift/Section/JWTEncoder" class="dashAnchor"></a>
<a href="#/JWTEncoder">
<h3 class="section-name">JWTEncoder</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/JWTEncoder"></a>
<h3 class="section-name"><p>JWTEncoder</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -270,9 +264,11 @@ <h4>Declaration</h4>
<div class="task-name-container">
<a name="/JWTDecoder"></a>
<a name="//apple_ref/swift/Section/JWTDecoder" class="dashAnchor"></a>
<a href="#/JWTDecoder">
<h3 class="section-name">JWTDecoder</h3>
</a>
<div class="section-name-container">
<a class="section-name-link" href="#/JWTDecoder"></a>
<h3 class="section-name"><p>JWTDecoder</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -323,8 +319,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
17 changes: 9 additions & 8 deletions docs/Classes/ClaimsMicroProfile.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SwiftJWT Docs
SwiftJWT 3.6.200 Docs
</a>
(100% documented)
</p>
Expand All @@ -33,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -109,10 +109,11 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>ClaimsMicroProfile</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClaimsMicroProfile</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Claims.html">Claims</a></span></code></pre>

</div>
Expand All @@ -131,7 +132,7 @@ <h1>ClaimsMicroProfile</h1>
<code>
<a name="/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc"></a>
<a name="//apple_ref/swift/Method/init(iss:sub:exp:iat:jti:upn:groups:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:sub:exp:iat:jti:upn:groups:)</a>
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:<wbr>sub:<wbr>exp:<wbr>iat:<wbr>jti:<wbr>upn:<wbr>groups:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -282,7 +283,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <q>jti</q> (JWT ID) claim provides a unique identifier for the JWT.
<p>The &ldquo;jti&rdquo; (JWT ID) claim provides a unique identifier for the JWT.
The identifier value MUST be assigned in a manner that ensures that
there is a negligible probability that the same value will be
accidentally assigned to a different data object.</p>
Expand Down Expand Up @@ -312,7 +313,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the <q>preferred_username</q>, should be attempted, and if that claim is missing, fallback to the <q>sub</q> claim should be used.</p>
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the &ldquo;preferred_username&rdquo;, should be attempted, and if that claim is missing, fallback to the &ldquo;sub&rdquo; claim should be used.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -388,8 +389,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 0166688

Please sign in to comment.