1 /* 2 * Copyright 2020 Google LLC 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 * https://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 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/privacy/dlp/v2/dlp.proto 18 19 package com.google.privacy.dlp.v2; 20 21 public interface CryptoReplaceFfxFpeConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The key used by the encryption algorithm. 31 * </pre> 32 * 33 * <code> 34 * .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED]; 35 * </code> 36 * 37 * @return Whether the cryptoKey field is set. 38 */ hasCryptoKey()39 boolean hasCryptoKey(); 40 /** 41 * 42 * 43 * <pre> 44 * Required. The key used by the encryption algorithm. 45 * </pre> 46 * 47 * <code> 48 * .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED]; 49 * </code> 50 * 51 * @return The cryptoKey. 52 */ getCryptoKey()53 com.google.privacy.dlp.v2.CryptoKey getCryptoKey(); 54 /** 55 * 56 * 57 * <pre> 58 * Required. The key used by the encryption algorithm. 59 * </pre> 60 * 61 * <code> 62 * .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED]; 63 * </code> 64 */ getCryptoKeyOrBuilder()65 com.google.privacy.dlp.v2.CryptoKeyOrBuilder getCryptoKeyOrBuilder(); 66 67 /** 68 * 69 * 70 * <pre> 71 * The 'tweak', a context may be used for higher security since the same 72 * identifier in two different contexts won't be given the same surrogate. If 73 * the context is not set, a default tweak will be used. 74 * If the context is set but: 75 * 1. there is no record present when transforming a given value or 76 * 1. the field is not present when transforming a given value, 77 * a default tweak will be used. 78 * Note that case (1) is expected when an `InfoTypeTransformation` is 79 * applied to both structured and unstructured `ContentItem`s. 80 * Currently, the referenced field may be of value type integer or string. 81 * The tweak is constructed as a sequence of bytes in big endian byte order 82 * such that: 83 * - a 64 bit integer is encoded followed by a single byte of value 1 84 * - a string is encoded in UTF-8 format followed by a single byte of value 2 85 * </pre> 86 * 87 * <code>.google.privacy.dlp.v2.FieldId context = 2;</code> 88 * 89 * @return Whether the context field is set. 90 */ hasContext()91 boolean hasContext(); 92 /** 93 * 94 * 95 * <pre> 96 * The 'tweak', a context may be used for higher security since the same 97 * identifier in two different contexts won't be given the same surrogate. If 98 * the context is not set, a default tweak will be used. 99 * If the context is set but: 100 * 1. there is no record present when transforming a given value or 101 * 1. the field is not present when transforming a given value, 102 * a default tweak will be used. 103 * Note that case (1) is expected when an `InfoTypeTransformation` is 104 * applied to both structured and unstructured `ContentItem`s. 105 * Currently, the referenced field may be of value type integer or string. 106 * The tweak is constructed as a sequence of bytes in big endian byte order 107 * such that: 108 * - a 64 bit integer is encoded followed by a single byte of value 1 109 * - a string is encoded in UTF-8 format followed by a single byte of value 2 110 * </pre> 111 * 112 * <code>.google.privacy.dlp.v2.FieldId context = 2;</code> 113 * 114 * @return The context. 115 */ getContext()116 com.google.privacy.dlp.v2.FieldId getContext(); 117 /** 118 * 119 * 120 * <pre> 121 * The 'tweak', a context may be used for higher security since the same 122 * identifier in two different contexts won't be given the same surrogate. If 123 * the context is not set, a default tweak will be used. 124 * If the context is set but: 125 * 1. there is no record present when transforming a given value or 126 * 1. the field is not present when transforming a given value, 127 * a default tweak will be used. 128 * Note that case (1) is expected when an `InfoTypeTransformation` is 129 * applied to both structured and unstructured `ContentItem`s. 130 * Currently, the referenced field may be of value type integer or string. 131 * The tweak is constructed as a sequence of bytes in big endian byte order 132 * such that: 133 * - a 64 bit integer is encoded followed by a single byte of value 1 134 * - a string is encoded in UTF-8 format followed by a single byte of value 2 135 * </pre> 136 * 137 * <code>.google.privacy.dlp.v2.FieldId context = 2;</code> 138 */ getContextOrBuilder()139 com.google.privacy.dlp.v2.FieldIdOrBuilder getContextOrBuilder(); 140 141 /** 142 * 143 * 144 * <pre> 145 * Common alphabets. 146 * </pre> 147 * 148 * <code> 149 * .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4; 150 * </code> 151 * 152 * @return Whether the commonAlphabet field is set. 153 */ hasCommonAlphabet()154 boolean hasCommonAlphabet(); 155 /** 156 * 157 * 158 * <pre> 159 * Common alphabets. 160 * </pre> 161 * 162 * <code> 163 * .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4; 164 * </code> 165 * 166 * @return The enum numeric value on the wire for commonAlphabet. 167 */ getCommonAlphabetValue()168 int getCommonAlphabetValue(); 169 /** 170 * 171 * 172 * <pre> 173 * Common alphabets. 174 * </pre> 175 * 176 * <code> 177 * .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4; 178 * </code> 179 * 180 * @return The commonAlphabet. 181 */ getCommonAlphabet()182 com.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet(); 183 184 /** 185 * 186 * 187 * <pre> 188 * This is supported by mapping these to the alphanumeric characters 189 * that the FFX mode natively supports. This happens before/after 190 * encryption/decryption. 191 * Each character listed must appear only once. 192 * Number of characters must be in the range [2, 95]. 193 * This must be encoded as ASCII. 194 * The order of characters does not matter. 195 * The full list of allowed characters is: 196 * <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz 197 * ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code> 198 * </pre> 199 * 200 * <code>string custom_alphabet = 5;</code> 201 * 202 * @return Whether the customAlphabet field is set. 203 */ hasCustomAlphabet()204 boolean hasCustomAlphabet(); 205 /** 206 * 207 * 208 * <pre> 209 * This is supported by mapping these to the alphanumeric characters 210 * that the FFX mode natively supports. This happens before/after 211 * encryption/decryption. 212 * Each character listed must appear only once. 213 * Number of characters must be in the range [2, 95]. 214 * This must be encoded as ASCII. 215 * The order of characters does not matter. 216 * The full list of allowed characters is: 217 * <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz 218 * ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code> 219 * </pre> 220 * 221 * <code>string custom_alphabet = 5;</code> 222 * 223 * @return The customAlphabet. 224 */ getCustomAlphabet()225 java.lang.String getCustomAlphabet(); 226 /** 227 * 228 * 229 * <pre> 230 * This is supported by mapping these to the alphanumeric characters 231 * that the FFX mode natively supports. This happens before/after 232 * encryption/decryption. 233 * Each character listed must appear only once. 234 * Number of characters must be in the range [2, 95]. 235 * This must be encoded as ASCII. 236 * The order of characters does not matter. 237 * The full list of allowed characters is: 238 * <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz 239 * ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code> 240 * </pre> 241 * 242 * <code>string custom_alphabet = 5;</code> 243 * 244 * @return The bytes for customAlphabet. 245 */ getCustomAlphabetBytes()246 com.google.protobuf.ByteString getCustomAlphabetBytes(); 247 248 /** 249 * 250 * 251 * <pre> 252 * The native way to select the alphabet. Must be in the range [2, 95]. 253 * </pre> 254 * 255 * <code>int32 radix = 6;</code> 256 * 257 * @return Whether the radix field is set. 258 */ hasRadix()259 boolean hasRadix(); 260 /** 261 * 262 * 263 * <pre> 264 * The native way to select the alphabet. Must be in the range [2, 95]. 265 * </pre> 266 * 267 * <code>int32 radix = 6;</code> 268 * 269 * @return The radix. 270 */ getRadix()271 int getRadix(); 272 273 /** 274 * 275 * 276 * <pre> 277 * The custom infoType to annotate the surrogate with. 278 * This annotation will be applied to the surrogate by prefixing it with 279 * the name of the custom infoType followed by the number of 280 * characters comprising the surrogate. The following scheme defines the 281 * format: info_type_name(surrogate_character_count):surrogate 282 * For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and 283 * the surrogate is 'abc', the full replacement value 284 * will be: 'MY_TOKEN_INFO_TYPE(3):abc' 285 * This annotation identifies the surrogate when inspecting content using the 286 * custom infoType 287 * [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). 288 * This facilitates reversal of the surrogate when it occurs in free text. 289 * In order for inspection to work properly, the name of this infoType must 290 * not occur naturally anywhere in your data; otherwise, inspection may 291 * find a surrogate that does not correspond to an actual identifier. 292 * Therefore, choose your custom infoType name carefully after considering 293 * what your data looks like. One way to select a name that has a high chance 294 * of yielding reliable detection is to include one or more unicode characters 295 * that are highly improbable to exist in your data. 296 * For example, assuming your data is entered from a regular ASCII keyboard, 297 * the symbol with the hex code point 29DD might be used like so: 298 * ⧝MY_TOKEN_TYPE 299 * </pre> 300 * 301 * <code>.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;</code> 302 * 303 * @return Whether the surrogateInfoType field is set. 304 */ hasSurrogateInfoType()305 boolean hasSurrogateInfoType(); 306 /** 307 * 308 * 309 * <pre> 310 * The custom infoType to annotate the surrogate with. 311 * This annotation will be applied to the surrogate by prefixing it with 312 * the name of the custom infoType followed by the number of 313 * characters comprising the surrogate. The following scheme defines the 314 * format: info_type_name(surrogate_character_count):surrogate 315 * For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and 316 * the surrogate is 'abc', the full replacement value 317 * will be: 'MY_TOKEN_INFO_TYPE(3):abc' 318 * This annotation identifies the surrogate when inspecting content using the 319 * custom infoType 320 * [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). 321 * This facilitates reversal of the surrogate when it occurs in free text. 322 * In order for inspection to work properly, the name of this infoType must 323 * not occur naturally anywhere in your data; otherwise, inspection may 324 * find a surrogate that does not correspond to an actual identifier. 325 * Therefore, choose your custom infoType name carefully after considering 326 * what your data looks like. One way to select a name that has a high chance 327 * of yielding reliable detection is to include one or more unicode characters 328 * that are highly improbable to exist in your data. 329 * For example, assuming your data is entered from a regular ASCII keyboard, 330 * the symbol with the hex code point 29DD might be used like so: 331 * ⧝MY_TOKEN_TYPE 332 * </pre> 333 * 334 * <code>.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;</code> 335 * 336 * @return The surrogateInfoType. 337 */ getSurrogateInfoType()338 com.google.privacy.dlp.v2.InfoType getSurrogateInfoType(); 339 /** 340 * 341 * 342 * <pre> 343 * The custom infoType to annotate the surrogate with. 344 * This annotation will be applied to the surrogate by prefixing it with 345 * the name of the custom infoType followed by the number of 346 * characters comprising the surrogate. The following scheme defines the 347 * format: info_type_name(surrogate_character_count):surrogate 348 * For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and 349 * the surrogate is 'abc', the full replacement value 350 * will be: 'MY_TOKEN_INFO_TYPE(3):abc' 351 * This annotation identifies the surrogate when inspecting content using the 352 * custom infoType 353 * [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). 354 * This facilitates reversal of the surrogate when it occurs in free text. 355 * In order for inspection to work properly, the name of this infoType must 356 * not occur naturally anywhere in your data; otherwise, inspection may 357 * find a surrogate that does not correspond to an actual identifier. 358 * Therefore, choose your custom infoType name carefully after considering 359 * what your data looks like. One way to select a name that has a high chance 360 * of yielding reliable detection is to include one or more unicode characters 361 * that are highly improbable to exist in your data. 362 * For example, assuming your data is entered from a regular ASCII keyboard, 363 * the symbol with the hex code point 29DD might be used like so: 364 * ⧝MY_TOKEN_TYPE 365 * </pre> 366 * 367 * <code>.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;</code> 368 */ getSurrogateInfoTypeOrBuilder()369 com.google.privacy.dlp.v2.InfoTypeOrBuilder getSurrogateInfoTypeOrBuilder(); 370 getAlphabetCase()371 public com.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase(); 372 } 373