Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/readme #21

Merged
merged 4 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
path: warden/build/test-results/**/TEST*.xml
reporter: java-junit
- name: Upload jar
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: warden
path: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-pages-only.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
# Upload docs folder
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
# Upload docs folder
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## NEXT


## 2.3.3
- include latest WARDEN-roboto to work around upstream bug [#77](https://github.com/google/android-key-attestation/issues/77)
- Dependency Updates:
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ val warden = Warden(
verificationSecondsOffset = -300, //OPTIONAL, defaults to 0
disableHardwareAttestation = false, //OPTIONAL, defaults to false. Set to true to disable HW attestation
enableNougatAttestation = false, //OPTIONAL, defaults to false. Set to true to enable hybrid attestation
enableSoftwareAttestation = false //OPTIONAL, defaults to false. Set to true to enable SW attestation
enableSoftwareAttestation = false, //OPTIONAL, defaults to false. Set to true to enable SW attestation
attestationStatementValiditySeconds = 300 //OPTIONAL, defaults to 300s
),
iosAttestationConfiguration = IOSAttestationConfiguration(
applications = listOf(
Expand All @@ -180,14 +181,15 @@ val warden = Warden(
)
),
iosVersion = 14, //OPTIONAL, null by default
attestationStatementValiditySeconds = 300 //OPTIONAL, defaults to 300s
),
clock = FixedTimeClock(Instant.parse("2023-04-13T00:00:00Z")), //OPTIONAL, system clock by default,
verificationTimeOffset = Duration.ZERO //OPTIONAL, defaults to zero
)
```

The (nullable) properties like patch level, iOS version or Android app version essentially allow for excluding outdated devices.
Custom android challenge verification has been omitted by design, considering iOS constraints and inconsistencies resulting from such a customisation.
Defining a custom logic to verify the attestation challenge for Android is unsupported by design, considering iOS constraints and inconsistencies between platforms resulting from such a customisation.
More details on the configuration can be found in the API documentation

#### A Note on Android Attestation
Expand All @@ -201,10 +203,9 @@ no real use case for such a configuration.
Note that not all flavours use different the same root of trust by default.

### Example Usage
While still not complete, the test suite in this repository should provide a nice overview. [FeatureDemonstration](https://github.com/a-sit-plus/warden/blob/main/warden/src/test/kotlin/FeatureDemonstration.kt),
in particular, was designed to demonstrate this library's API.
While still not complete, the test suite in this repository should provide a nice overview.
<br>
See the provided [sample service](https://github.com/a-sit-plus/warden/tree/main/sample/backend) and its mobile clients for an MWE that integrates this library.
See also the provided [sample service](https://github.com/a-sit-plus/warden/tree/main/sample/backend) and its mobile clients for an MWE that integrates this library.
The sample also contains Android and iOS clients.

#### Obtaining a Key Attestation Result
Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
jdk.version=17
artifactVersion=2.3.3
androidAttestationVersion=1.7.2
artifactVersion=2.3.4-SNAPSHOT
androidAttestationVersion=1.7.3-SNAPSHOT
2 changes: 1 addition & 1 deletion warden-roboto
Loading