Limiting acceptable web nodes
[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 registerBefore : (string -> unit) -> unit
31 val registerAfter : (string -> unit) -> unit
32 (* Register handlers to run just before and after entering a domain
33 * block. *)
34
35 val currentDomain : unit -> string
36
37 val domainFile : {node : string, name : string} -> TextIO.outstream
38 (* Open one of the current domain's configuration files for a particular
39 * node. *)
40
41 val dnsMaster : unit -> string option
42 (* Name of the node that is the DNS master for the current domain, if there
43 * is one *)
44
45 val nodes : string list
46 (* Names of all system nodes *)
47 val nodeMap : string Ast.StringMap.map
48 (* Map node names to IP addresses *)
49 val nodeIp : string -> string
50 (* Look up a node in nodeMap *)
51
52 val setUser : string -> unit
53 val getUser : unit -> string
54 (* Name of the UNIX user providing this configuration *)
55
56 val your_domains : unit -> DataStructures.StringSet.set
57 (* The domains the current user may configure *)
58
59 val your_users : unit -> DataStructures.StringSet.set
60 val your_groups : unit -> DataStructures.StringSet.set
61 val your_paths : unit -> DataStructures.StringSet.set
62 (* UNIX users, groups, and paths the user may act with *)
63
64 val set_context : OpenSSL.context -> unit
65
66 val inGroup : string -> bool
67 end