Imported Upstream version 1.10.2
[platform/upstream/krb5.git] / src / kadmin / testing / util / tcl_kadm5_syntax
1 Here's a brief summary of the syntax of the tcl versions of the
2 kadm5 functions:
3
4 string          Can be a string or "null" which will turn into a null pointer
5 principal_ent   A 12-field list in the order of the principal_ent
6                 structure: {string number number number number string
7                             number mask number number string mask}
8                 It can also be "null", like a string, to indicate that
9                 a null structure pointer should be used.
10 mask            Either a number, representing the actual value of the
11                 mask, or a sequence of symbols in a list.  Example:
12                 {PRINCIPAL ATTRIBUTES} is a valid principal mask.
13 boolean         "1", "0", "true", "false", etc.
14 varname         The name of a Tcl variable, or "null" to not assign.
15 policy_ent      Similar to principal_ent, but with seven fields,
16                 instead of 12.  The first is a string, and the rest
17                 are numbers.
18
19 init
20                 client_name:string pass:string service_name:string
21                 realm:string struct_version:int api_version:int
22                 server_handle_ret:varname
23 destroy
24                 server_handle:string
25 create_principal
26                 server_handle:string principal:principal_ent
27                 mask:principal_mask password:string
28 delete_principal
29                 server_handle:string name:string
30 modify_principal
31                 server_handle:string principal_principal_ent
32                 mask:principal_mask
33 rename_principal
34                 server_handle:string source:string target:string
35 chpass_principal
36                 server_handle:string name:string password:string
37 chpass_principal_util
38                 server_handle:string name:string password:string
39                 pw_ret:varname msg_ret:varname
40 randkey_principal
41                 server_handle:string name:string keyblock_var:varname
42 get_principal [-struct]
43                 server_handle:string name:string princ_var:varname
44 create_policy
45                 server_handle:string policy:policy_ent mask:policy_mask
46 delete_policy
47                 server_handle:string name:string
48 modify_policy
49                 server_handle:string policy:policy_ent mask:policy_mask
50 get_policy [-struct]
51                 server_handle:string name:string policy_var:varname
52 free_principal_ent
53                 server_handle:string handle:string
54 free_policy_ent
55                 server_handle:string handle:string
56 get_privs
57                 server_handle:string privs:priv_var