securityd/src/child.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, 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 //
  26 // child - track a single child process and its belongings
  27 //
  28 #ifndef _CHILD_H_
  29 #define _CHILD_H_  1
  30
  31 #include <security_utilities/mach++.h>
  32 #include <security_utilities/unixchild.h>
  33
  34 using MachPlusPlus::Port;
  35 using MachPlusPlus::TaskPort;
  36
  37
  38 //
  39 // ServerChild builds on the generic UNIX Child abstraction.
  40 // The child is expected to engage in a checkin protocol after launch,
  41 // whereby it RPC-calls childCheckIn in securityd and thus authenticates
  42 // and declares readiness to provide service.
  43 //
  44 // @@@ PerWhat are these, if they are at all?
  45 //
  46 class ServerChild : public UnixPlusPlus::Child {
  47 public:
  48         ServerChild();
  49         ~ServerChild();
  50
  51         Port servicePort() const { return mServicePort; }
  52         bool ready() const { return mServicePort; }
  53
  54 public:
  55         static void checkIn(Port servicePort, pid_t pid);
  56
  57 protected:
  58         void childAction() = 0;         // must be provided by subclass
  59         void parentAction();            // fully implemented
  60         void dying();                           // fully implemented
  61
  62 private:
  63         Port mServicePort;                      // child's main service port
  64
  65 private:
  66         typedef map<pid_t, ServerChild *> CheckinMap;
  67         static CheckinMap mCheckinMap;
  68
  69         // The parent side will wait on mCheckinCond until the child checks in
  70         // or fails. During that time ONLY, mCheckinLock protects the entire Child
  71         // object.
  72         static Mutex mCheckinLock;
  73         Condition mCheckinCond;
  74 };
  75
  76
  77 #endif // _CHILD_H_