Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 7.0.0
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-macdslocal_core', '1.0.3'
Learn more about managing modules with a PuppetfileDocumentation
macdslocal_core
Table of Contents
- Description
- Setup - The basics of getting started with macdslocal_core
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
The macdslocal_core module is used to manage local OS X Directory Service objects.
Setup
Setup Requirements OPTIONAL
The types and providers rely on the CFPropertyList gem. If you are using puppet-agent
packages, then those prerequisities are already satisfied on OS X.
Reference
Please see REFERENCE.md for the reference documentation.
This module is documented using Puppet Strings.
For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.
To generate documentation locally, run
bundle install
bundle exec puppet strings generate ./lib/**/*.rb
This command will create a browsable _index.html
file in the doc
directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.
Limitations
This module is only available on OS X platforms that have the CFPropertyList gem installed.
Development
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
For more information, see our module contribution guide.
Reference
Table of Contents
Resource types
computer
: Computer object management using DirectoryService on OS X. Note that these are distinctly different kinds of objects to 'hosts', as they reqmacauthorization
: Manage the Mac OS X authorization database. See the [Apple developer site](https://developer.apple.com/library/content/documentation/Securitymcx
: MCX object management using DirectoryService on OS X. The default provider of this type merely manages the XML plist as reported by the `dsc
Resource types
computer
Computer object management using DirectoryService on OS X.
Note that these are distinctly different kinds of objects to 'hosts', as they require a MAC address and can have all sorts of policy attached to them.
This provider only manages Computer objects in the local directory service domain, not in remote directories.
If you wish to manage /etc/hosts
file on Mac OS X, then simply use the host
type as per other platforms.
This type primarily exists to create localhost Computer objects that MCX policy can then be attached to.
Autorequires: If Puppet is managing the plist file representing a
Computer object (located at /var/db/dslocal/nodes/Default/computers/{name}.plist
),
the Computer resource will autorequire it.
Properties
The following properties are available in the computer
type.
ensure
Valid values: present, absent
Control the existences of this computer record. Set this attribute to
present
to ensure the computer record exists. Set it to absent
to delete any computer records with this name
en_address
The MAC address of the primary network interface. Must match en0.
ip_address
The IP Address of the Computer object.
Parameters
The following parameters are available in the computer
type.
name
namevar
The authoritative 'short' name of the computer record.
realname
The 'long' name of the computer record.
macauthorization
Manage the Mac OS X authorization database. See the Apple developer site for more information.
Note that authorization store directives with hyphens in their names have been renamed to use underscores, as Puppet does not react well to hyphens in identifiers.
Autorequires: If Puppet is managing the /etc/authorization
file, each
macauthorization resource will autorequire it.
Properties
The following properties are available in the macauthorization
type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
auth_type
Valid values: right, rule
Type --- this can be a right
or a rule
. The comment
type has
not yet been implemented.
allow_root
Valid values: true
, false
Corresponds to allow-root
in the authorization store. Specifies
whether a right should be allowed automatically if the requesting process
is running with uid == 0
. AuthorizationServices defaults this attribute
to false if not specified.
authenticate_user
Valid values: true
, false
Corresponds to authenticate-user
in the authorization store.
auth_class
Valid values: user, evaluate-mechanisms, allow, deny, rule
Corresponds to class
in the authorization store; renamed due
to 'class' being a reserved word in Puppet.
comment
The comment
attribute for authorization resources.
group
A group which the user must authenticate as a member of. This must be a single group.
k_of_n
How large a subset of rule mechanisms must succeed for successful
authentication. If there are 'n' mechanisms, then 'k' (the integer value
of this parameter) mechanisms must succeed. The most common setting for
this parameter is 1
. If k-of-n
is not set, then every mechanism ---
that is, 'n-of-n' --- must succeed.
mechanisms
An array of suitable mechanisms.
rule
The rule(s) that this right refers to.
session_owner
Valid values: true
, false
Whether the session owner automatically matches this rule or right.
Corresponds to session-owner
in the authorization store.
shared
Valid values: true
, false
Whether the Security Server should mark the credentials used to gain this right as shared. The Security Server may use any shared credentials to authorize this right. For maximum security, set sharing to false so credentials stored by the Security Server for one application may not be used by another application.
timeout
The number of seconds in which the credential used by this rule will expire. For maximum security where the user must authenticate every time, set the timeout to 0. For minimum security, remove the timeout attribute so the user authenticates only once per session.
tries
The number of tries allowed.
Parameters
The following parameters are available in the macauthorization
type.
name
namevar
The name of the right or rule to be managed.
Corresponds to key
in Authorization Services. The key is the name
of a rule. A key uses the same naming conventions as a right. The
Security Server uses a rule's key to match the rule with a right.
Wildcard keys end with a '.'. The generic rule has an empty key value.
Any rights that do not match a specific rule use the generic rule.
mcx
MCX object management using DirectoryService on OS X.
The default provider of this type merely manages the XML plist as
reported by the dscl -mcxexport
command. This is similar to the
content property of the file type in Puppet.
The recommended method of using this type is to use Work Group Manager
to manage users and groups on the local computer, record the resulting
puppet manifest using the command puppet resource mcx
, then deploy it
to other machines.
Autorequires: If Puppet is managing the user, group, or computer that these MCX settings refer to, the MCX resource will autorequire that user, group, or computer.
Properties
The following properties are available in the mcx
type.
ensure
Valid values: present, absent
Create or remove the MCX setting.
content
The XML Plist used as the value of MCXSettings in DirectoryService. This is the standard output from the system command:
dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name
Note that ds_type
is capitalized and plural in the dscl command.
Parameters
The following parameters are available in the mcx
type.
name
namevar
The name of the resource being managed. The default naming convention follows Directory Service paths:
/Computers/localhost
/Groups/admin
/Users/localadmin
The ds_type
and ds_name
type parameters are not necessary if the
default naming convention is followed.
ds_type
Valid values: user, group, computer, computerlist
The DirectoryService type this MCX setting attaches to.
ds_name
The name to attach the MCX Setting to. (For example, localhost
when ds_type => computer
.) This setting is not required, as it can be
automatically discovered when the resource name is parseable. (For
example, in /Groups/admin
, group
will be used as the dstype.)
Types in this module release
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
1.0.3 - 2019-01-11
Added
- Add LICENSE file
1.0.2 - 2018-08-20
Added
- (PUP-9053) Enable localization
Changed
- (PUP-9052) Bump puppet req to at least puppet 6
- Support puppet 6
1.0.1 - 2018-06-03
Changed
- (maint) Bump version and remove unneeded appveyor config
1.0.0 - 2018-06-29
Summary
This is the initial release of the extracted mailalias module
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.