├── templates └── default │ └── authorized_keys.erb ├── CHANGELOG.md ├── metadata.rb ├── recipes └── sysadmins.rb ├── CONTRIBUTING ├── resources └── manage.rb ├── providers └── manage.rb ├── README.md └── LICENSE /templates/default/authorized_keys.erb: -------------------------------------------------------------------------------- 1 | # Dropped off by Chef, thanks! 2 | <% Array(@ssh_keys).each do |key| %> 3 | <%= key %> 4 | <% end %> 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## v1.1.2: 2 | 3 | * [COOK-1076] - authorized_keys template not found in another cookbook 4 | 5 | ## v1.1.0: 6 | 7 | * [COOK-623] - LWRP conversion 8 | -------------------------------------------------------------------------------- /metadata.rb: -------------------------------------------------------------------------------- 1 | maintainer "Opscode, Inc." 2 | maintainer_email "cookbooks@opscode.com" 3 | license "Apache 2.0" 4 | description "Creates users from a databag search" 5 | long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) 6 | version "1.1.2" 7 | 8 | %w{ ubuntu debian redhat centos fedora freebsd}.each do |os| 9 | supports os 10 | end 11 | -------------------------------------------------------------------------------- /recipes/sysadmins.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: users 3 | # Recipe:: sysadmins 4 | # 5 | # Copyright 2011, Eric G. Wolfe 6 | # Copyright 2009-2011, Opscode, Inc. 7 | # 8 | # Licensed under the Apache License, Version 2.0 (the "License"); 9 | # you may not use this file except in compliance with the License. 10 | # You may obtain a copy of the License at 11 | # 12 | # http://www.apache.org/licenses/LICENSE-2.0 13 | # 14 | # Unless required by applicable law or agreed to in writing, software 15 | # distributed under the License is distributed on an "AS IS" BASIS, 16 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 | # See the License for the specific language governing permissions and 18 | # limitations under the License. 19 | # 20 | 21 | # Searches data bag "users" for groups attribute "sysadmin". 22 | # Places returned users in Unix group "sysadmin" with GID 2300. 23 | users_manage "sysadmin" do 24 | group_id 2300 25 | action [ :remove, :create ] 26 | end 27 | -------------------------------------------------------------------------------- /CONTRIBUTING: -------------------------------------------------------------------------------- 1 | If you would like to contribute, please open a ticket in JIRA: 2 | 3 | * http://tickets.opscode.com 4 | 5 | Create the ticket in the COOK project and use the cookbook name as the 6 | component. 7 | 8 | For all code contributions, we ask that contributors sign a 9 | contributor license agreement (CLA). Instructions may be found here: 10 | 11 | * http://wiki.opscode.com/display/chef/How+to+Contribute 12 | 13 | When contributing changes to individual cookbooks, please do not 14 | modify the version number in the metadata.rb. Also please do not 15 | update the CHANGELOG.md for a new version. Not all changes to a 16 | cookbook may be merged and released in the same versions. Opscode will 17 | handle the version updates during the release process. You are welcome 18 | to correct typos or otherwise make updates to documentation in the 19 | README. 20 | 21 | If a contribution adds new platforms or platform versions, indicate 22 | such in the body of the commit message(s), and update the relevant 23 | COOK ticket. When writing commit messages, it is helpful for others if 24 | you indicate the COOK ticket. For example: 25 | 26 | git commit -m '[COOK-1041] Updated pool resource to correctly delete.' 27 | 28 | In the ticket itself, it is also helpful if you include log output of 29 | a successful Chef run, but this is not absolutely required. 30 | -------------------------------------------------------------------------------- /resources/manage.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: users 3 | # Resources:: manage 4 | # 5 | # Copyright 2011, Eric G. Wolfe 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | # Data bag user object needs an "action": "remove" tag to actually be removed by the action. 21 | actions :create, :remove 22 | 23 | # :data_bag is the object to search 24 | # :search_group is the groups name to search for, defaults to resource name 25 | # :group_name is the string name of the group to create, defaults to resource name 26 | # :group_id is the numeric id of the group to create 27 | # :cookbook is the name of the cookbook that the authorized_keys template should be found in 28 | attribute :data_bag, :kind_of => String, :default => "users" 29 | attribute :search_group, :kind_of => String, :name_attribute => true 30 | attribute :group_name, :kind_of => String, :name_attribute => true 31 | attribute :group_id, :kind_of => Integer, :required => true 32 | attribute :cookbook, :kind_of => String, :default => "users" 33 | 34 | def initialize(*args) 35 | super 36 | @action = :create 37 | end 38 | -------------------------------------------------------------------------------- /providers/manage.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: users 3 | # Provider:: manage 4 | # 5 | # Copyright 2011, Eric G. Wolfe 6 | # Copyright 2009-2011, Opscode, Inc. 7 | # 8 | # Licensed under the Apache License, Version 2.0 (the "License"); 9 | # you may not use this file except in compliance with the License. 10 | # You may obtain a copy of the License at 11 | # 12 | # http://www.apache.org/licenses/LICENSE-2.0 13 | # 14 | # Unless required by applicable law or agreed to in writing, software 15 | # distributed under the License is distributed on an "AS IS" BASIS, 16 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 | # See the License for the specific language governing permissions and 18 | # limitations under the License. 19 | # 20 | 21 | def initialize(*args) 22 | super 23 | @action = :create 24 | end 25 | 26 | action :remove do 27 | if Chef::Config[:solo] 28 | Chef::Log.warn("This recipe uses search. Chef Solo does not support search.") 29 | else 30 | search(new_resource.data_bag, "groups:#{new_resource.search_group} AND action:remove") do |rm_user| 31 | user rm_user['id'] do 32 | action :remove 33 | end 34 | end 35 | new_resource.updated_by_last_action(true) 36 | end 37 | end 38 | 39 | action :create do 40 | security_group = Array.new 41 | 42 | if Chef::Config[:solo] 43 | Chef::Log.warn("This recipe uses search. Chef Solo does not support search.") 44 | else 45 | search(new_resource.data_bag, "groups:#{new_resource.search_group} AND NOT action:remove") do |u| 46 | security_group << u['id'] 47 | 48 | if node['apache'] and node['apache']['allowed_openids'] 49 | Array(u['openid']).compact.each do |oid| 50 | node['apache']['allowed_openids'] << oid unless node['apache']['allowed_openids'].include?(oid) 51 | end 52 | end 53 | 54 | # Set home to location in data bag, 55 | # or a reasonable default (/home/$user). 56 | if u['home'] 57 | home_dir = u['home'] 58 | else 59 | home_dir = "/home/#{u['id']}" 60 | end 61 | 62 | # The user block will fail if the group does not yet exist. 63 | # See the -g option limitations in man 8 useradd for an explanation. 64 | # This should correct that without breaking functionality. 65 | if u['gid'] and u['gid'].kind_of?(Numeric) 66 | group u['id'] do 67 | gid u['gid'] 68 | end 69 | end 70 | 71 | # Create user object. 72 | # Do NOT try to manage null home directories. 73 | user u['id'] do 74 | uid u['uid'] 75 | if u['gid'] 76 | gid u['gid'] 77 | end 78 | shell u['shell'] 79 | comment u['comment'] 80 | if home_dir == "/dev/null" 81 | supports :manage_home => false 82 | else 83 | supports :manage_home => true 84 | end 85 | home home_dir 86 | end 87 | 88 | if home_dir != "/dev/null" 89 | directory "#{home_dir}/.ssh" do 90 | owner u['id'] 91 | group u['gid'] || u['id'] 92 | mode "0700" 93 | end 94 | 95 | if u['ssh_keys'] 96 | template "#{home_dir}/.ssh/authorized_keys" do 97 | source "authorized_keys.erb" 98 | cookbook new_resource.cookbook 99 | owner u['id'] 100 | group u['gid'] || u['id'] 101 | mode "0600" 102 | variables :ssh_keys => u['ssh_keys'] 103 | end 104 | end 105 | end 106 | end 107 | end 108 | 109 | group new_resource.group_name do 110 | gid new_resource.group_id 111 | members security_group 112 | end 113 | new_resource.updated_by_last_action(true) 114 | end 115 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Description 2 | =========== 3 | 4 | Creates users from a databag search. 5 | 6 | Requirements 7 | ============ 8 | 9 | Platform 10 | -------- 11 | 12 | * Debian, Ubuntu 13 | * CentOS, Red Hat, Fedora 14 | * FreeBSD 15 | 16 | A data bag populated with user objects must exist. The default data bag in this recipe is `users`. See USAGE. 17 | 18 | Usage 19 | ===== 20 | 21 | This cookbook is specific for setting up `sysadmin` group and users for now. 22 | 23 | include_recipe "users::sysadmins" 24 | 25 | Use knife to create a data bag for users. 26 | 27 | knife data bag create users 28 | 29 | Create a user in the data_bag/users/ directory. Or not 30 | 31 | knife data bag users bofh 32 | { 33 | "id": "bofh", 34 | "ssh_keys": "ssh-rsa AAAAB3Nz...yhCw== bofh", 35 | "groups": [ "sysadmin", "dba", "devops" ], 36 | "uid": 2001, 37 | "shell": "\/bin\/bash", 38 | "comment": "BOFH", 39 | "nagios": { 40 | "pager": "8005551212@txt.att.net", 41 | "email": "bofh@example.com" 42 | }, 43 | "openid": "bofh.myopenid.com" 44 | } 45 | 46 | Remove a user, johndoe1. 47 | 48 | knife data bag users johndoe1 49 | { 50 | "id": "johndoe1", 51 | "groups": [ "sysadmin", "dba", "devops" ], 52 | "uid": 2002, 53 | "action": "remove", 54 | "comment": "User quit, retired, or fired." 55 | } 56 | 57 | * Note only user bags with the "action : remove" and a search-able "group" attribute will be purged by the :remove action. 58 | 59 | The default recipe makes use of the `users_manage` Lightweight Resource Provider (LWRP), and looks like this: 60 | 61 | 62 | ``` 63 | users_manage "sysadmin" do 64 | group_id 2300 65 | action [ :remove, :create ] 66 | end 67 | ``` 68 | 69 | Note this LWRP searches the `users` data bag for the `sysadmin` group attribute, and adds those users to a Unix security group `sysadmin`. The only required attribute is group_id, which represents the numeric Unix gid and *must* be unique. The default action for the LWRP is `:create` only. 70 | 71 | If you have different requirements, for example: 72 | 73 | * You want to search a different data bag specific to a role such as mail. You may change the data_bag searched. 74 | - data_bag `mail` 75 | * You want to search for a different group attribute named `postmaster`. You may change the search_group attribute. This attribute defaults to the LWRP resource name. 76 | - search_group `postmaster` 77 | * You want to add the users to a security group other than the lightweight resource name. You may change the group_name attribute. This attribute also defaults to the LWRP resource name. 78 | - group_name `wheel` 79 | 80 | Putting these requirements together our recipe might look like this: 81 | 82 | ``` 83 | users_manage "postmaster" do 84 | data_bag "mail" 85 | group_name "wheel" 86 | group_id 10 87 | end 88 | ``` 89 | 90 | The latest version of knife supports reading data bags from a file and automatically looks in a directory called +data_bags+ in the current directory. The "bag" should be a directory with JSON files of each item. For the above: 91 | 92 | mkdir data_bags/users 93 | $EDITOR data_bags/users/bofh.json 94 | 95 | Paste the user's public SSH key into the ssh_keys value. Also make sure the uid is unique, and if you're not using bash, that the shell is installed. The default search, and Unix group is sysadmin. 96 | 97 | The recipe, by default, will also create the sysadmin group. If you're using the opscode sudo cookbook, they'll have sudo access in the default site-cookbooks template. They won't have passwords though, so the sudo cookbook's template needs to be adjusted so the sysadmin group has NOPASSWD. 98 | 99 | The sysadmin group will be created with GID 2300. This may become an attribute at a later date. 100 | 101 | The Apache cookbook can set up authentication using OpenIDs, which is set up using the openid key here. See the Opscode 'apache2' cookbook for more information about this. 102 | 103 | License and Author 104 | ================== 105 | 106 | Author:: Joshua Timberman () 107 | Author:: Seth Chisamore () 108 | 109 | Copyright:: 2009-2011, Opscode, Inc 110 | 111 | Licensed under the Apache License, Version 2.0 (the "License"); 112 | you may not use this file except in compliance with the License. 113 | You may obtain a copy of the License at 114 | 115 | http://www.apache.org/licenses/LICENSE-2.0 116 | 117 | Unless required by applicable law or agreed to in writing, software 118 | distributed under the License is distributed on an "AS IS" BASIS, 119 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 120 | See the License for the specific language governing permissions and 121 | limitations under the License. 122 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 202 | --------------------------------------------------------------------------------