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.

Sign up for GitHub

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

Exposure risk calculation algorithm #24

Merged
merged 5 commits into from
Jul 21, 2020
Merged

Exposure risk calculation algorithm #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
991a6dd
Add javadocs to risk calculation parameters and functions
Stypox Jul 4, 2020
d8991dc
Add functions to get intermediary risk scores for values
Stypox Jul 6, 2020
6b5a383
Add getRiskScore() to calculate the final risk score for a set of values
Stypox Jul 6, 2020
8bfd5f7
Make ExposureConfiguration instances immutable
Stypox Jul 7, 2020
36b288f
Add test for risk score algorithm
Stypox Jul 13, 2020
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
30 changes: 23 additions & 7 deletions coralibre-sdk/sdk/src/main/java/org/coralibre/android/sdk/fakegms/nearby/Nearby.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
package org.coralibre.android.sdk.fakegms.nearby;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import org.coralibre.android.sdk.fakegms.nearby.exposurenotification.ExposureConfiguration;
import org.coralibre.android.sdk.fakegms.nearby.exposurenotification.ExposureInformation;
import org.coralibre.android.sdk.fakegms.nearby.exposurenotification.ExposureSummary;
import org.coralibre.android.sdk.fakegms.nearby.exposurenotification.TemporaryExposureKey;
import org.coralibre.android.sdk.fakegms.tasks.Task;
import org.coralibre.android.sdk.fakegms.tasks.TaskAutorunOnceListenersThere;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.util.List;
Expand All @@ -25,7 +27,7 @@ public class Nearby {
private static Nearby instance = null;


public static Nearby getExposureNotificationClient(@NotNull Object context) {
public static Nearby getExposureNotificationClient(@NonNull Object context) {
// This strange type name mismatching is expected by the rki app.

if (instance == null) {
Expand Down Expand Up @@ -84,11 +86,25 @@ public void runInternal() {
}


public Task<Void> provideDiagnosisKeys(
List<File> keyFiles,
ExposureConfiguration configuration, // might be null!
String token
) {
/**
* Adds keys of infected people contained in {@code keyFiles} to the database and
* provides to the client the {@code exposureConfiguration} to use to calculate risk
*
* @see <a href="https://developers.google.com/android/exposure-notifications/exposure-notifications-api#providediagnosiskeys">description on developers.google.com</a>
* @param keyFiles a list of files to extract the keys of confirmed cases from, obtained from
* an internet-accessible server. The file format is described
* <a href="https://developers.google.com/android/exposure-notifications/exposure-key-file-format">on developers.google.com</a>
* [TODO still unused]
* @param exposureConfiguration the configuration to use to calculate risk exposure, needs to
* be provided before calling {@link #getExposureSummary(String)}
* and {@link #getExposureInformation(String)}
* @param token identifier that could be randomly generated for every call or reused to group
* together results in calls to {@link #getExposureSummary(String)}
* and {@link #getExposureInformation(String)} [TODO still unused]
* @return a runnable task
*/
public Task<Void> provideDiagnosisKeys(final List<File> keyFiles,
@Nullable final ExposureConfiguration exposureConfiguration, final String token) {
return new TaskAutorunOnceListenersThere<Void>() {
@Override
public void runInternal() {
Expand Down
Loading