OSX/sec/SOSCircle/Tool/keychain_sync.h

   1 /*
   2  * Copyright (c) 2013-2014 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
  25 #include <SecurityTool/security_tool_commands.h>
  26
  27 SECURITY_COMMAND(
  28         "sync", keychain_sync,
  29         "[options]\n"
  30         "Keychain Syncing\n"
  31         "    -d     disable\n"
  32         "    -e     enable (join/create circle)\n"
  33         "    -i     info (current status)\n"
  34         "    -m     dump my peer\n"
  35         "    -s     schedule sync with all peers\n"
  36         "\n"
  37         "Account/Circle Management\n"
  38         "    -a     accept all applicants\n"
  39         "    -l     [reason] sign out of circle + set custom departure reason\n"
  40         "    -q     sign out of circle\n"
  41         "    -r     reject all applicants\n"
  42         "    -E     ensure fresh parameters\n"
  43     "    -b     device|all|single Register a backup bag - THIS RESETS BACKUPS!\n"
  44     "    -A     Apply to a ring\n"
  45     "    -B     Withdrawl from a ring\n"
  46     "    -G     Enable Ring\n"
  47     "    -F     Ring Status\n"
  48     "    -I     Dump Ring Information\n"
  49         "    -N     (re-)set to new account (USE WITH CARE: device will not leave circle before resetting account!)\n"
  50         "    -O     reset to offering\n"
  51         "    -R     reset circle\n"
  52         "    -X     [limit]  best effort bail from circle in limit seconds\n"
  53     "    -o     list view unaware peers in circle\n"
  54     "    -0     boot view unaware peers from circle\n"
  55     "    -1     grab account state from the keychain\n"
  56     "    -2     delete account state from the keychain\n"
  57     "    -3     grab engine state from the keychain\n"
  58     "    -4     delete engine state from the keychain\n"
  59
  60         "\n"
  61         "IDS\n"
  62         "    -g     set IDS device id\n"
  63         "    -p     retrieve IDS device id\n"
  64         "    -x     ping all devices in an IDS account\n"
  65         "    -w     check IDS availability\n"
  66         "    -z     retrieve IDS id through IDSKeychainSyncingProxy\n"
  67         "\n"
  68         "Password\n"
  69         "    -P     [label:]password  set password (optionally for a given label) for sync\n"
  70         "    -T     [label:]password  try password (optionally for a given label) for sync\n"
  71         "\n"
  72         "KVS\n"
  73         "    -k     pend all registered kvs keys\n"
  74         "    -C     clear all values from KVS\n"
  75         "    -D     [itemName]  dump contents of KVS\n"
  76         "    -W     sync and dump\n"
  77         "\n"
  78         "Misc\n"
  79         "    -v     [enable|disable|query:viewname] enable, disable, or query my PeerInfo's view set\n"
  80         "             viewnames are: keychain|masterkey|iclouddrive|photos|cloudkit|escrow|fde|maildrop|icloudbackup|notes|imessage|appletv|homekit\n"
  81     "                            wifi|passwords|creditcards|icloudidentity|othersyncable\n"
  82     "    -L     list all known view and their status\n"
  83         "    -S     [enable|disable|propertyname] enable, disable, or query my PeerInfo's Security Property set\n"
  84         "             propertynames are: hasentropy|screenlock|SEP|IOS\n"
  85         "    -U     purge private key material cache\n"
  86     "    -V     Report View Sync Status on all known clients.\n"
  87     "    -Y     Report yet to initial sync views\n"
  88     "    -H     Set escrow record.\n"
  89     "    -J     Get the escrow record.\n"
  90     "    -M     Check peer availability.\n",
  91         "Keychain Syncing controls." )