keychain/ot/proto/OTPairingMessage.proto

   1 /*
   2  * Copyright (c) 2018 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 syntax = "proto2";
  25
  26 option objc_class_naming = "extended";
  27 option objc_class_visibility = "hidden";
  28
  29 package OT;
  30
  31 enum SupportType {
  32     unknown = 0;
  33     supported = 1;
  34     not_supported = 2;
  35 }
  36
  37 message supportSOSMessage {
  38     optional SupportType supported = 1;
  39 }
  40
  41 message supportOctagonMessage {
  42     optional SupportType supported = 1;
  43 }
  44
  45 message SponsorToApplicantRound1M2 {
  46     optional uint64 epoch = 1;
  47 }
  48
  49 message ApplicantToSponsorRound2M1 {
  50     optional string peerID = 1;
  51     optional bytes permanentInfo = 2;
  52     optional bytes permanentInfoSig = 3;
  53     optional bytes stableInfo = 4;
  54     optional bytes StableInfoSig = 5;
  55 }
  56
  57 message SponsorToApplicantRound2M2{
  58     optional bytes voucher = 1;
  59     optional bytes voucherSignature = 2;
  60     // Claimed for a field, but never used
  61     //reserved 3;
  62 }
  63
  64 message PairingMessage {
  65     optional SponsorToApplicantRound1M2 epoch = 1;
  66     optional ApplicantToSponsorRound2M1 prepare = 2;
  67     optional SponsorToApplicantRound2M2 voucher = 3;
  68     // <rdar://problem/55465193> reserved is not a keyword (it should be)
  69     // reserved 4;
  70     optional supportOctagonMessage supportsOctagon = 5;
  71     optional supportSOSMessage supportsSOS = 6;
  72 }