chef_fixie_shahid 0.5.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7a3dfd490674a4bdfe48472718b21f40cc29dd1c969e095cfa20493d6120e068
4
+ data.tar.gz: 9b3e69d524edcfae3c3a41adee8a9f740a0136bf5b8092d8cf4e20fb2c552661
5
+ SHA512:
6
+ metadata.gz: 2e81318f05760594c75c4a6eda5df1c9336891da31796ca99f27a6d24281d589c10b356e53dda1000dc8138a8557ff416fa462d632549ee522a8727573f1d565
7
+ data.tar.gz: 69cb244f8f561e19f203d7e1dd22b1f2265925a854d9603489e962d56abbb44544ba43edf59b609eb0937f00416985c82b1882dec30cc373313fa01b39814774
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,69 @@
1
+ fixie
2
+ =====
3
+
4
+ Low level manipulation tool for Chef Server 12 and later.
5
+
6
+ This tool is in its very early stages, and should be used with great care.
7
+
8
+ ## Purpose
9
+
10
+ Provide a tool to debug and fix low level problems with chef server, especially those surrounding ACLs and
11
+ groups. This tool works at an extremely low level, and provides minimal protection against data loss and
12
+ corruption. If a problem can be fixed using the API, that should be done instead. This exists for those use
13
+ cases where the API can't be used.
14
+
15
+ ## History
16
+
17
+ For many years orgmapper has been a useful, if somewhat frustrating tool to debug and fix low level problems
18
+ with chef server, especially those surrounding ACLs and groups. The tool has never been stable, and has
19
+ suffered from somewhat arcane syntax.
20
+
21
+ Orgmapper became increasingly broken with the move to use sql instead of couchdb, and the obsolescence of
22
+ mixlib-authorization, opscode-account and the rest of the ruby based chef, and became completely useless with
23
+ the migration of organizations to SQL. Yet the need for a low level editing tool remains.
24
+
25
+ ## Goals
26
+
27
+ * Allow the repair of common problems such as organization lockouts, broken ACLs and the like.
28
+
29
+ * Tests: All functionality should be part of CI, and run as part of nightly tests. We should treat breakage
30
+ of fixie as a issue to be addressed like any other CI failure.
31
+
32
+ * Scriptability: We have a collection of scripts for diagnosing and fixing user problems written against
33
+ orgamapper; these scripts should be ported and enhanced to make them more generally useful.
34
+
35
+
36
+ ## Documentation
37
+
38
+ Documentation can be found in in the doc directory, especially the
39
+ [doc/GETTING_STARTED.md](doc/GETTING_STARTED.md) file.
40
+
41
+ ## Bugs/Issues/Pull Requests
42
+
43
+ Please file bugs/issues/pull requests against the [fixie](https://github.com/chef/fixie) repository in
44
+ github.
45
+
46
+ ## License
47
+
48
+ | | |
49
+ |:---------------------|:-----------------------------------------|
50
+ | **Copyright:** | Copyright (c) 2014-2015 Chef Software, Inc.
51
+ | **License:** | Apache License, Version 2.0
52
+
53
+
54
+ All files in the repository are licensed under the Apache 2.0 license. If any file is missing the License
55
+ header it should assume the following is attached;
56
+
57
+ Copyright 2014 Chef Software Inc.
58
+
59
+ Licensed under the Apache License, Version 2.0 (the "License");
60
+ you may not use this file except in compliance with the License.
61
+ You may obtain a copy of the License at
62
+
63
+ http://www.apache.org/licenses/LICENSE-2.0
64
+
65
+ Unless required by applicable law or agreed to in writing, software
66
+ distributed under the License is distributed on an "AS IS" BASIS,
67
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
68
+ See the License for the specific language governing permissions and
69
+ limitations under the License.
data/bin/chef_fixie ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require_relative "../lib/chef_fixie/console"
4
+
5
+ ChefFixie::Console.start
@@ -0,0 +1,68 @@
1
+
2
+ Basics:
3
+ -------
4
+
5
+ Underneath everything is the Ruby Sequel library; there are a number
6
+ of ways to access it.
7
+
8
+ Check out http://ricostacruz.com/cheatsheets/sequel.html or the Sequel
9
+ gem docs for details of the sequel library.
10
+
11
+ Many objects in fixie have the accessor inner, which exposes the
12
+ Sequel selector. This includes:
13
+ * The constants ORGS, USERS, ASSOCIATIONS, and INVITES
14
+ ```ruby
15
+ ORGS.inner.first
16
+ #< @values={:id=>"7ddaee6b42e8f6a0a8e9d5d5efe644f8", :authz_id=>"f46b2e53869968ce115b97d2fd8bfee0", :name=>"ponyville", :full_name=>"ponyville", :assigned_at=>2015-07-21 18:22:34 UTC, :last_updated_by=>"08076ed32f7d5c62721607dd2c309c55", :created_at=>2015-07-21 18:22:34 UTC, :updated_at=>2015-07-21 18:22:34 UTC}>
17
+ ```
18
+ * Any of the by_XXXX accessors
19
+ ```ruby
20
+ ORGS['
21
+
22
+
23
+ ```
24
+
25
+
26
+
27
+
28
+
29
+ fixie:0 > o.groups.by_name(cl.id).inner.count
30
+ 1
31
+ fixie:0 > o.groups.by_name(cl.id).inner.delete
32
+ 1
33
+ fixie:0 > o.groups.by_name(cl.id).inner.count
34
+
35
+
36
+ * Changing email for user in fixie
37
+
38
+ USERS.by_username('anujbiyani').inner.update(:email=>"anujbiyani01@gmail.com")
39
+
40
+
41
+
42
+ * Adding a record
43
+ ```ruby
44
+ u=USERS['a_username']
45
+ o=ORGS['an_org']
46
+ pivotal = USERS['pivotal']
47
+ now = Sequel.function(:NOW)
48
+
49
+ ASSOCS.inner.insert(:org_id=>o.id, :user_id=>u.id, :last_updated_by=>pivotal.authz_id,
50
+ :created_at=>now, :updated_at=>now )
51
+ ```
52
+
53
+
54
+ * Fixing a group that lost its authz object.
55
+ We've seen the users group in hosted loose it's authz entry
56
+
57
+ ```ruby
58
+ a = Fixie::AuthzApi.new
59
+ # create a new authz group
60
+ g = a.post("groups",{})
61
+ # check that only one group is returned
62
+ ORGS['acme'].groups.by_name('users').inner.all
63
+ # alter the group and insert the new authz id
64
+ ORGS['acme'].groups.by_name('users').inner.update(:authz_id=>g.id)
65
+ ```
66
+
67
+ This does not add the users back to the usergs group, or re-add users
68
+ all the acls that used to have the users group in them.
data/doc/BulkFixup.md ADDED
@@ -0,0 +1,33 @@
1
+ Restoring acl permissions globally
2
+ ============
3
+
4
+ If a key group is deleted (such as users)
5
+
6
+ * Verify that the org has issues
7
+
8
+ * Create/restore the group
9
+ (TBW)
10
+
11
+ * Add the users/groups back to the group
12
+ (TBW)
13
+
14
+ * Set the group ACL appropriately
15
+ ```ruby
16
+ users_group.ace_add([:create,:read,:update,:delete], org.groups['admins'])
17
+ users_group.ace_add([:create,:read,:update,:delete], USERS['pivotal'])
18
+ ```
19
+
20
+ * Restore users to the appropriate container ACLs
21
+ ```ruby
22
+ org = ORGS[THE_ORG]
23
+ cl = %w(cookbooks data nodes roles environments policies policy_groups cookbook_artifacts)
24
+ cl.each {|c| o.containers[c].ace_add([:create,:read,:update,:delete], org.groups['users']) }
25
+ %w(clients).each { |c| org.containers[c].ace_add([:read,:delete], org.groups['users']) }
26
+ %w(groups containers).each { |c| org.containers[c].ace_add([:read], org.groups['users']) }
27
+ %w(sandboxes).each { |c| org.containers[c].ace_add([:create], org.groups['users']) }
28
+ ```
29
+
30
+ * Then update the objects from the containers:
31
+ ```ruby
32
+ Fixie::BulkEditPermissions::copy_from_containers(org)
33
+ ```
@@ -0,0 +1,31 @@
1
+
2
+
3
+
4
+ Automated organization checkup
5
+ ----------
6
+
7
+ If you don't know what's up with an org, there are a few easy starting
8
+ points
9
+
10
+ First of all, run the automated org association checker:
11
+
12
+ fixie:0 > Fixie::CheckOrgAssociations.check_associations("acme")
13
+ Org acme is ok (6 users)
14
+
15
+ If it reports a problem with a user, you may be able to fix it
16
+ automatically:
17
+
18
+ fixie:0 > Fixie::CheckOrgAssociations.fix_association("acme", "mary")
19
+
20
+ This might need to be run multiple times to fix all of the errors.
21
+
22
+
23
+ Removing a user completely from an org
24
+ -----------
25
+
26
+ [1] fixie(main)> ChefFixie::CheckOrgAssociations.remove_association('the_org', 'the_user')
27
+
28
+ This removes the user from the org, and removes them from all org
29
+ groups. However, if the user has been individually added to an ACL we
30
+ don't fix that up; it would require enumeration of the whole org, and
31
+ that hasn't been implemented.
@@ -0,0 +1,228 @@
1
+
2
+ Installing fixie
3
+ -------
4
+ In the fixie directory, run `bundle install --binstubs`
5
+
6
+ Configuring fixie
7
+ -------
8
+
9
+ On chef server installs, fixie can read configuration information out
10
+ of /etc/opscode, specifically the chef-server-running.json file.
11
+
12
+ Otherwise, you will need a fixie.conf file with the appropriate URIs and secrets for
13
+ accessing postgres and bifrost.
14
+
15
+ The fixie.conf.example file contains examples from a instance of
16
+ private chef.
17
+
18
+ | Attribute | Description | Example |
19
+ |-----------|-------------|---------|
20
+ | authz_uri | The URI for the bifrost/authz service | http://localhost:9463 |
21
+ | superuser\_id | The authz superuser id | fa84f0f5524a06baaa10b0f988ff2d8f |
22
+ | sql\_database | A Ruby Sequel compatible database URI with user and password | postgres://opscode_chef:3b2bb8affc0b87233130f820443aecca2061fadc6c0df16828233e433877ca1c552d1b9d40d3971f0e8c21fc4b7ff9471d91@localhost/opscode_chef |
23
+
24
+ Running fixie
25
+ ------
26
+
27
+ Start fixie with
28
+ ```shell
29
+ bin/fixie fixie.conf
30
+ ```
31
+ The config file is optional, leaving it out will attempt to read
32
+ /etc/opscode for configuration.
33
+
34
+ Inspecting objects
35
+ ------
36
+
37
+ There are two core class hierarchies in fixie, one corresponding to a
38
+ table (e.g. Orgs), and another corresponding to a row in the table
39
+ (e.g. Org). The naming convention is that the plural refers to the
40
+ table and the singular refers to the row. These are tightly coupled,
41
+ and generally if one exists the other will too.
42
+
43
+ The table class (e.g. Orgs) provides access to the raw Sequel
44
+ objects. There are several constants in the REPL containing
45
+ pre-initialized instances of the commonly accessed table classes,
46
+ including ORGS, USERS, ASSOCIATIONS, and INVITES.
47
+
48
+ #### Standard accessors
49
+
50
+ Each of these have accessors to search by various columns. These use the naming pattern #by\_XXXX, where XXX is the column name in the database. For example ORGS.by\_name('ponyville') searches for the org named 'ponyville'. The return value from this accessor is a new instance of the object that can be further refined. In many cases aliases have been added to hide naming quirks. For example groups use the 'groupname' column, but they can also be accessed using the #by\_name function.
51
+
52
+ The REPL supports method completion, so the list of supported filters can be found by typing `ORGS.by_` and hitting the tab key.
53
+
54
+ To get a list of all objects selected use the #all method. To list the names of the objects use the #list
55
+ method:
56
+
57
+ ```ruby
58
+ fixie:0 > ORGS.list
59
+ ["acme", "ponyville", "wonderbolts"]
60
+ fixie:0 > ORGS.all
61
+ [#<Fixie::Sql::Org:0x00000003886fa0 @data=#< @values={:id=>"ca0542c21119786fd4d2ddeb5c920ecf", :authz_id=>"baefe78d2fdab7d31fce7f4bdd6feda8", :name=>"ponyville", :full_name=>"ponyville", :assigned_at=>2015-02-05 03:06:33 UTC, :last_updated_by=>"9f6f823739fe6417b1c247ca0d2afdfc", :created_at=>2015-02-05 03:06:33 UTC, :updated_at=>2015-02-05 03:06:33 UTC}>>, #<Fixie::Sql::Org:0x00000003886f50 @data=#< @values={:id=>"2742f6f01ae95aa5998fd7ad94e0d383", :authz_id=>"52064f4a67a2b6c0243051e9f855699a", :name=>"wonderbolts", :full_name=>"wonderbolts", :assigned_at=>2015-02-05 03:07:05 UTC, :last_updated_by=>"9f6f823739fe6417b1c247ca0d2afdfc", :created_at=>2015-02-05 03:07:05 UTC, :updated_at=>2015-02-05 03:07:05 UTC}>>, #<Fixie::Sql::Org:0x00000003886f28 @data=#< @values={:id=>"0434803f600f1688707081921cf92721", :authz_id=>"b9a9dee90b6c2ab31cf4350aeba59460", :name=>"acme", :full_name=>"acme", :assigned_at=>2015-02-05 03:07:32 UTC, :last_updated_by=>"9f6f823739fe6417b1c247ca0d2afdfc", :created_at=>2015-02-05 03:07:32 UTC, :updated_at=>2015-02-05 03:07:32 UTC}>>]
62
+ ```
63
+
64
+ The #all and #list functions have protection against accidentally grabbing the entire table; if too many
65
+ results are included (currently 10), it returns `:too_many_results` instead. Providing a parameter to the #all
66
+ and #list function adjusts the limit.
67
+
68
+ Any object that has a well defined 'name' has the index ('[]') accessor provided; this takes a string and
69
+ returns a single exact match for it if it exists.
70
+
71
+ #### Predefined objects
72
+ * USERS
73
+
74
+ This allows access to the users table in sql.
75
+
76
+ To get the user named 'rainbowdash'
77
+ ```ruby
78
+ > u = USERS['rainbowdash']
79
+ #<Fixie::Sql::User:0x00000002afea18 @data=#< @values={:id=>"0000000000004d3eac4cc85b2bdddd0f", :authz_id=>"070dc1cd727a6b71e48d5e16f8d7b137", :username=>"rainbowdash", :email=>"rainbowdash@ponyville.com", :pubkey_version=>0, :public_key=>"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr0ZeWeIuU+rO2m1Pe8Nk\n7kzkqmk+CbaP8CVc0OlPZZITgoW2NEseCg1N3FVrCGIIY8vhDkyPST7ZKNva/hOo\nltC8inN695wRchQ1EDpVityL7EIuu7haXBib2WA2HQezlRWKMdrMGGRq0bMa3lD4\nV/YfEXSBtkE8W7QaanbtpgipWC1VGorj0MLR+++JYGd9kqGp49DiC7FH+DChE6pj\nRD9d25/chclD+svZy7RW0s2Q0/H/qRjhOdHoBGljJohVF64CsfqhDCr02zytbKDy\n6sOFjFneSqDZhlx81uVtQ0l+H+0bx77zbwLtp/WjpUFjw/yA8V92/WCjvwMTUaRN\nxQIDAQAB\n-----END PUBLIC KEY-----\n\n", :serialized_object=>"{\"display_name\":\"rainbowdash pony\",\"first_name\":\"rainbowdash\",\"last_name\":\"pony\",\"middle_name\":\"\"}", :last_updated_by=>"c8bd48b83f61031c29ab4ff5168fccd2", :created_at=>2014-10-31 16:59:37 UTC, :updated_at=>2014-10-31 16:59:37 UTC, :external_authentication_uid=>nil, :recovery_authentication_enabled=>false, :admin=>false, :hashed_password=>"$2a$12$FZMrxfVxWLpj8xPiBXG6SO2YxqGMp3zAj7I4w7cr50y1VbCbgIrUe", :salt=>"$2a$12$FZMrxfVxWLpj8xPiBXG6SO", :hash_type=>"bcrypt"}>>
80
+ ```
81
+
82
+
83
+ To see just the name of that user:
84
+ ```ruby
85
+ > u.name
86
+ "rainbowdash"
87
+ ```
88
+
89
+ To find all users with ponyville in their name:
90
+ ```ruby
91
+ > USERS.by_email(/ponyville/)
92
+ #<Fixie::Sql::Users:0x00000003514200 @inner=#<Sequel::Postgres::Dataset: "SELECT * FROM \"users\" WHERE (\"email\" ~ 'ponyville')">>
93
+ ```
94
+
95
+ Note this returns a users table object which can be refined
96
+ further. To process the list of users selected, use the #all method:
97
+ ```ruby
98
+ > USERS.by_email(/ponyville/).all.map {|x| x.name }
99
+ ["rainbowdash", "fluttershy", "applejack", "pinkiepie", "twilightsparkle", "rarity"]
100
+ ```
101
+
102
+ To further refine the set of objects further selectors can be applied:
103
+ ```ruby
104
+ fixie:0 > USERS.by_email(/ponyville/).by_username(/apple/).all.first.name
105
+ "applejack"
106
+ ```
107
+
108
+ The #all method has a hidden limit (which may be changed in future versions). It has takes a paramenter max\_count (defaults to 10). If it will return more than max\_count elements it returns :too\_many\_results instead; this is to prevent filling the screen or slammming the database by accident.
109
+ ```ruby
110
+ fixie:0 > USERS.all
111
+ :too_many_results
112
+ ```
113
+ * ORGS
114
+
115
+ ORGS work very similarly to USERS, but the org object return also adds accessors for org scoped objects such as nodes, roles, groups, containers, etc.
116
+
117
+ ```ruby
118
+ fixie:0 > ORGS['ponyville'].full_name
119
+ "ponyville"
120
+
121
+ fixie:0 > ORGS['ponyville'].groups.all.map {|x| x.name}
122
+ ["admins", "billing-admins", "clients", "0000000000004d3eac4cc85b2bdddd0f", "000000000000506ccf528a2844e81838", "000000000000808da6731453e12eb2bb", "000000000000dfccddd011ce219caaf0", "00000000000036639a19f27527b29a3e", "000000000000224a1c0e395b112c1d20", "users"]
123
+ ```
124
+
125
+ * ASSOCS
126
+ * INVITES
127
+ * GLOBAL\_GROUPS
128
+ * GLOBAL\_CONTAINERS
129
+
130
+ Altering ACLs and Groups
131
+ -----------
132
+
133
+
134
+ #### Editing ACLs
135
+
136
+ The objects returned by the above selectors have accessors to allow editing of acl and group membership.
137
+
138
+ ACLs can be viewed for any object
139
+ ```ruby
140
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].acl
141
+ {"create"=>{"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"]]}, "read"=>{"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"]]}, "update"=>{"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"]]}, "delete"=>{"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"]]}, "grant"=>{"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"]]}}
142
+ ```
143
+
144
+ Individual ACEs can be viewed
145
+
146
+ ```ruby
147
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace(:read)
148
+ {"actors"=>[[:global, "pivotal"], [:global, "fluttershy"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"]]}
149
+ ```
150
+
151
+ Users and groups can be added to an ACE. The APIs are 'magic' in the sense that they can take an object and figure out if it is an actor or group and add it appropriately.
152
+
153
+ ```ruby
154
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_add(:read, USERS['fluttershy'])
155
+ {}
156
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_add(:read, GLOBAL_GROUPS['ponyville_global_admins'])
157
+ {}
158
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace(:read)
159
+ {"actors"=>[[:global, "pivotal"], [:global, "fluttershy"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"], ["unknown-00000000000000000000000000000000", "ponyville_global_admins"]]}
160
+ ```
161
+
162
+ And removed:
163
+ ```ruby
164
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_delete(:read, GLOBAL_GROUPS['ponyville_global_admins'])
165
+ {}
166
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace(:read)
167
+ {"actors"=>[[:global, "pivotal"], [:global, "fluttershy"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"]]}
168
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_delete(:read, USERS['fluttershy'])
169
+ {}
170
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace(:read)
171
+ {"actors"=>[[:global, "pivotal"]], "groups"=>[["ponyville", "admins"], ["ponyville", "users"]]}
172
+ ```
173
+
174
+ The ace\_add and ace\_delete functions take the symbols :create, :read, :update, :delete and :grant in
175
+ the action field. The user can also provide an array of those symbols for bulk operations, or
176
+ specify :all to edit all of the actions.
177
+
178
+ ```ruby
179
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_add(:all, USERS['pivotal'])
180
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].ace_add([:read,:update], USERS['fluttershy'])
181
+ ```
182
+
183
+
184
+ ##### Copying ACLs
185
+
186
+ Sometimes it is useful to copy permisons from one object to another. For example, if an object has
187
+ had a catastrophic permission edit, you'd like to at least restore the permissions it would have
188
+ inherited from the container. This command *adds* permissions from another object, but does not
189
+ remove any permisions already there.
190
+
191
+ ```ruby
192
+ fixie:0 > clients_container = ORGS['ponyville'].containers['clients']
193
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].acl_add_from_object(clients_container)
194
+ ```
195
+
196
+ ##### Raw access
197
+
198
+
199
+
200
+ There are also _raw versions of these functions that work on the raw authz ids
201
+ ```ruby
202
+ fixie:0 > ORGS['ponyville'].clients['ponyville-validator'].acl_raw
203
+ {"create"=>{"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>["ca0a8cabaafaae658edd298ddd4266cd"]}, "read"=>{"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>["ca0a8cabaafaae658edd298ddd4266cd", "690063dd87f110eabfa5ba387b8e280f"]}, "update"=>{"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>["ca0a8cabaafaae658edd298ddd4266cd"]}, "delete"=>{"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>["ca0a8cabaafaae658edd298ddd4266cd", "690063dd87f110eabfa5ba387b8e280f"]}, "grant"=>{"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>["ca0a8cabaafaae658edd298ddd4266cd"]}}
204
+ ```
205
+
206
+ #### Editing groups
207
+
208
+ Groups can be viewed:
209
+ ```ruby
210
+ fixie:0 > ORGS['ponyville'].groups['admins'].group
211
+ {"actors"=>[[:global, "pivotal"]], "groups"=>[]}
212
+ ```
213
+
214
+ Members can be added/removed from groups:
215
+ ```ruby
216
+ fixie:0 > ORGS['ponyville'].groups['admins'].group_add(USERS['fluttershy'])
217
+ {}
218
+ fixie:0 > ORGS['ponyville'].groups['admins'].group_delete(USERS['fluttershy'])
219
+ {}
220
+ ```
221
+
222
+ Again there are raw functions that take raw authz ids.
223
+ ```ruby
224
+ fixie:0 > ORGS['ponyville'].groups['admins'].group_raw
225
+ {"actors"=>["c8bd48b83f61031c29ab4ff5168fccd2"], "groups"=>[]}
226
+ ```
227
+
228
+