src/domain.sig

   1 (* HCoop Domtool (http://hcoop.sourceforge.net/)
   2  * Copyright (c) 2006, Adam Chlipala
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  *)
  18
  19 (* Domain-related primitive actions *)
  20
  21 signature DOMAIN = sig
  22
  23     val yourPath : string -> bool
  24     val isIdent : char -> bool
  25     val validHost : string -> bool
  26     val validDomain : string -> bool
  27     val yourDomain : string -> bool
  28     val validUser : string -> bool
  29     val validEmailUser : string -> bool
  30
  31     val ip : string Env.arg
  32
  33     val registerResetGlobal : (unit -> unit) -> unit
  34     val registerResetLocal : (unit -> unit) -> unit
  35     (* Register functions for clearing out all Domtool configuration at the global
  36      * (AFS) and local levels, respectively. *)
  37
  38     val resetGlobal : unit -> unit
  39     val resetLocal : unit -> unit
  40     (* Call all registered functions *)
  41
  42     val registerBefore : (string -> unit) -> unit
  43     val registerAfter : (string -> unit) -> unit
  44     (* Register handlers to run just before and after entering a domain
  45      * block. *)
  46
  47     val currentDomain : unit -> string
  48
  49     val domainFile : {node : string, name : string} -> TextIO.outstream
  50     (* Open one of the current domain's configuration files for a particular
  51      * node. *)
  52
  53     val dnsMaster : unit -> string option
  54     (* Name of the node that is the DNS master for the current domain, if there
  55      * is one *)
  56
  57     val nodes : string list
  58     (* Names of all system nodes *)
  59     val nodeMap : string Ast.StringMap.map
  60     (* Map node names to IP addresses *)
  61     val nodeIp : string -> string
  62     (* Look up a node in nodeMap *)
  63
  64     val setUser : string -> unit
  65     val getUser : unit -> string
  66     (* Name of the UNIX user providing this configuration *)
  67
  68     val your_domains : unit -> DataStructures.StringSet.set
  69     (* The domains the current user may configure *)
  70
  71     val your_users : unit -> DataStructures.StringSet.set
  72     val your_groups : unit -> DataStructures.StringSet.set
  73     val your_paths : unit -> DataStructures.StringSet.set
  74     (* UNIX users, groups, and paths the user may act with *)
  75
  76     val set_context : OpenSSL.context -> unit
  77
  78     val hasPriv : string -> bool
  79
  80     val rmdom : string list -> unit
  81 end