Rmuser
[hcoop/domtool2.git] / 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
28 val ip : string Env.arg
29
30 val registerResetGlobal : (unit -> unit) -> unit
31 val registerResetLocal : (unit -> unit) -> unit
32 (* Register functions for clearing out all Domtool configuration at the global
33 * (AFS) and local levels, respectively. *)
34
35 val resetGlobal : unit -> unit
36 val resetLocal : unit -> unit
37 (* Call all registered functions *)
38
39 val registerBefore : (string -> unit) -> unit
40 val registerAfter : (string -> unit) -> unit
41 (* Register handlers to run just before and after entering a domain
42 * block. *)
43
44 val currentDomain : unit -> string
45
46 val domainFile : {node : string, name : string} -> TextIO.outstream
47 (* Open one of the current domain's configuration files for a particular
48 * node. *)
49
50 val dnsMaster : unit -> string option
51 (* Name of the node that is the DNS master for the current domain, if there
52 * is one *)
53
54 val nodes : string list
55 (* Names of all system nodes *)
56 val nodeMap : string Ast.StringMap.map
57 (* Map node names to IP addresses *)
58 val nodeIp : string -> string
59 (* Look up a node in nodeMap *)
60
61 val setUser : string -> unit
62 val getUser : unit -> string
63 (* Name of the UNIX user providing this configuration *)
64
65 val your_domains : unit -> DataStructures.StringSet.set
66 (* The domains the current user may configure *)
67
68 val your_users : unit -> DataStructures.StringSet.set
69 val your_groups : unit -> DataStructures.StringSet.set
70 val your_paths : unit -> DataStructures.StringSet.set
71 (* UNIX users, groups, and paths the user may act with *)
72
73 val set_context : OpenSSL.context -> unit
74
75 val hasPriv : string -> bool
76
77 val rmdom : string list -> unit
78 end