platform_sensor_util.h | Explore in Territory

// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SERVICES_DEVICE_GENERIC_SENSOR_PLATFORM_SENSOR_UTIL_H_
#define SERVICES_DEVICE_GENERIC_SENSOR_PLATFORM_SENSOR_UTIL_H_

#include "services/device/public/cpp/generic_sensor/sensor_reading.h"
#include "services/device/public/mojom/sensor.mojom-shared.h"

namespace device {

// Sensors are accurate enough that it is possible to sample sensor data to
// implement a "fingerprint attack" to reveal the sensor calibration data.
// This data is effectively a unique number, or fingerprint, for a device. To
// combat this, sensor values are rounded to the nearest multiple of some small
// number. This is still accurate enough to satisfy the needs of the sensor
// user, but guards against this attack.
//
// Additional info can be found at https://crbug.com/1018180.
//
// Rounding also protects against using the gyroscope as a primitive microphone
// to record audio. Additional info at https://crbug.com/1031190.

// Units are SI meters per second squared (m/s^2).
inline constexpr double kAccelerometerRoundingMultiple = …;

// Units are luxes (lx).
inline constexpr int kAlsRoundingMultiple = …;

// Units are radians/second. This value corresponds to 0.1 deg./sec.
inline constexpr double kGyroscopeRoundingMultiple = …;

// Units are degrees.
inline constexpr double kOrientationEulerRoundingMultiple = …;

// Units are radians. This value corresponds to 0.1 degrees.
inline constexpr double kOrientationQuaternionRoundingMultiple = …;

// Units are micro Teslas (μT).
inline constexpr double kMagnetometerRoundingMultiple = …;

// Some sensor types also ignore value changes below a certain threshold to
// avoid exposing whether a value is too close to the limit between one
// rounded value and the next.
inline constexpr int kAlsSignificanceThreshold = …;

// Round |value| to be a multiple of |multiple|.
//
// NOTE: Exposed for testing. Please use other Rounding functions below.
//
// Some examples:
//
// ( 1.24, 0.1) => 1.2
// ( 1.25, 0.1) => 1.3
// (-1.24, 0.1) => -1.2
// (-1.25, 0.1) => -1.3
double RoundToMultiple(double value, double multiple);

// Round accelerometer sensor reading to guard user privacy.
void RoundAccelerometerReading(SensorReadingXYZ* reading);

// Round gyroscope sensor reading to guard user privacy.
void RoundGyroscopeReading(SensorReadingXYZ* reading);

// Round ambient light sensor reading to guard user privacy.
void RoundIlluminanceReading(SensorReadingSingle* reading);

// Round orientation Euler angle sensor reading to guard user privacy.
void RoundOrientationEulerReading(SensorReadingXYZ* reading);

// Round orientation quaternion sensor reading to guard user privacy.
// |reading| is assumed to be unscaled (unit length).
void RoundOrientationQuaternionReading(SensorReadingQuat* reading);

// Round magnetometer reading to guard user privacy.
void RoundMagnetometerReading(SensorReadingXYZ* reading);

// Round the sensor reading to guard user privacy.
void RoundSensorReading(SensorReading* reading, mojom::SensorType sensor_type);

}  // namespace device

#endif  // SERVICES_DEVICE_GENERIC_SENSOR_PLATFORM_SENSOR_UTIL_H_
chromium/services/device/generic_sensor/platform_sensor_util.h
