Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Yi Jin | b592e3b | 2018-02-01 15:17:04 -0800 | [diff] [blame^] | 16 | #pragma once |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 17 | |
| 18 | #ifndef PRIVACY_H |
| 19 | #define PRIVACY_H |
| 20 | |
| 21 | #include <stdint.h> |
| 22 | |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 23 | // This is the default value of DEST enum, sync with privacy.proto |
Yi Jin | b592e3b | 2018-02-01 15:17:04 -0800 | [diff] [blame^] | 24 | const uint8_t DEST_UNSET = 255; // DEST_UNSET is not exposed to libincident |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 25 | const uint8_t DEST_DEFAULT_VALUE = DEST_UNSET; |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 26 | |
| 27 | /* |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 28 | * In order to NOT auto-generate large chuck of code by proto compiler in incidentd, |
| 29 | * privacy options's data structure are explicitly redefined here and |
| 30 | * the values are populated by incident_section_gen tool. |
| 31 | * |
| 32 | * Each proto field will have a Privacy when it is different from its parent, otherwise |
| 33 | * it uses its parent's tag. A message type will have an array of Privacy. |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 34 | */ |
| 35 | struct Privacy { |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 36 | // The field number |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 37 | uint32_t field_id; |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 38 | |
| 39 | // The field type, see external/protobuf/src/google/protobuf/descriptor.h |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 40 | uint8_t type; |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 41 | |
| 42 | // If children is null, it is a primitive field, |
| 43 | // otherwise it is a message field which could have overridden privacy tags here. |
| 44 | // This array is NULL-terminated. |
Yi Jin | 7e0b4e5 | 2017-09-12 20:00:25 -0700 | [diff] [blame] | 45 | Privacy** children; |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 46 | |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 47 | // DESTINATION Enum in frameworks/base/libs/incident/proto/android/privacy.proto. |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 48 | uint8_t dest; |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 49 | // A list of regexp rules for stripping string fields in proto. |
| 50 | const char** patterns; |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 51 | }; |
| 52 | |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 53 | // Encode field id used by ProtoOutputStream. |
| 54 | uint64_t encode_field_id(const Privacy* p); |
| 55 | |
| 56 | // Look up the child with given fieldId, if not found, return NULL. |
| 57 | const Privacy* lookup(const Privacy* p, uint32_t fieldId); |
| 58 | |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 59 | /** |
| 60 | * PrivacySpec defines the request has what level of privacy authorization. |
| 61 | * For example, a device without user consent should only be able to upload AUTOMATIC fields. |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 62 | * DEST_UNSET are treated as DEST_EXPLICIT. |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 63 | */ |
| 64 | class PrivacySpec { |
| 65 | public: |
| 66 | const uint8_t dest; |
| 67 | |
| 68 | PrivacySpec() : dest(DEST_DEFAULT_VALUE) {} |
Yi Jin | 0f04716 | 2017-09-05 13:44:22 -0700 | [diff] [blame] | 69 | bool operator<(const PrivacySpec& other) const; |
| 70 | |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 71 | // check permission of a policy, if returns true, don't strip the data. |
Yi Jin | b592e3b | 2018-02-01 15:17:04 -0800 | [diff] [blame^] | 72 | bool CheckPremission(const Privacy* privacy, |
| 73 | const uint8_t defaultDest = DEST_DEFAULT_VALUE) const; |
Yi Jin | bdf5894 | 2017-11-14 17:58:19 -0800 | [diff] [blame] | 74 | |
| 75 | // if returns true, no data need to be stripped. |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 76 | bool RequireAll() const; |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 77 | |
Yi Jin | 3ec5cc7 | 2018-01-26 13:42:43 -0800 | [diff] [blame] | 78 | // Constructs spec using static methods below. |
| 79 | static PrivacySpec new_spec(int dest); |
Yi Jin | b592e3b | 2018-02-01 15:17:04 -0800 | [diff] [blame^] | 80 | |
Yi Jin | 3ec5cc7 | 2018-01-26 13:42:43 -0800 | [diff] [blame] | 81 | private: |
| 82 | PrivacySpec(uint8_t dest) : dest(dest) {} |
| 83 | }; |
Yi Jin | 99c248f | 2017-08-25 18:11:58 -0700 | [diff] [blame] | 84 | |
Yi Jin | b592e3b | 2018-02-01 15:17:04 -0800 | [diff] [blame^] | 85 | #endif // PRIVACY_H |