open_directory_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 670f73215db5f440a0e47ace7c0efb2858491816ac0ce7a2de018d02c64f5f39
+  data.tar.gz: eff24211563c562e232ad371302dc7150221a5de41b37a0a943e7ed17701b0a4
+SHA512:
+  metadata.gz: 180370d46964faa772fc81141ae279b5f64844da98e0da2d005b3dce4785b74b234f87c96cbde847a3c218737b2bb8cb0fcaa9ea1464c0eaad674851807ef5d3
+  data.tar.gz: 599b339abc2e70a0aa24e154ce7cfd08ce05bc567fdca051329f11c22ac5855ccbc165730cd6ca2d5de47d8ab6439bc8a8ea9cc82a251df1513a4ed9526e4940

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.rbenv-vars
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at btihen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_directory_utils.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    open_directory_utils (0.1.0)
+      net-ssh (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    net-ssh (4.2.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  open_directory_utils!
+  rake (~> 12.3)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bill Tihen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# OpenDirectoryUtils
+
+This Gem allows one to build or send pre-built commands to control
+(common OD and LDAP attributes) on an OpenDirectory server.
+
+One can also build custom DSCL commands and send them to the server as needed too.
+
+## Change Log
+
+* **v0.1.0** - 2018-06-06
+  - can adjust and delete OD attributes for users and groups (pre-built ldap attributes comming soon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_directory_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_directory_utils
+
+## Usage
+
+```ruby
+require 'open_directory_utils'
+
+# Usually Instantiate using ENV-VARS -
+# srv_host_name: ENV['OD_HOSTNAME'],
+# srv_user_name: ENV['OD_USERNAME'],
+# dir_user_name: ENV['DIR_ADMIN_USER'],
+# dir_password: ENV['DIR_ADMIN_PASS'],
+
+# Instantiating using params
+od = OpenDirectoryUtils.new(
+        { srv_host_name: 'od_hostname', srv_user_name: 'od_ssh_username',
+          dir_user_name: 'directory_admin_username',
+          dir_password: 'directory_admin_password'
+        }
+      )
+
+user_params = { user_name: 'someone', user_number: 9876, group_number: 4321,
+                first_name: 'Someone', last__name: 'Special',
+              }
+group_params = {group_name: 'agroup', long_name: 'A Group', group_number: 5432}
+
+# create a user
+od.run( command: :user_create_full,  params: user_params )
+
+# update user's record (all dscl and ldap fields are available)
+od.run( command: :user_set_first_email,
+        params: {user_name: 'someone', email: 'someone@example.com'} )
+# add a second email address
+od.run( command: :user_append_email,
+        params: {user_name: 'someone', email: 'second@example.com'} )
+# fix spelling of first name
+od.run( command: :user_set_first_name,
+        params: {user_name: 'someone', first_name: 'John'} )
+
+# get user's record
+od.run( command: :user_info,  params: user_params )
+
+# create a group
+od.run( command: :group_create_full, params: group_params )
+
+# add the first user to the group
+od.run( command: :group_add_first_user,
+        params: {user_name: 'someone', group_name: 'agroup'} )
+# add additional user to the group
+od.run( command: :user_append_to_group,
+        params: {user_name: 'existinguser', group_name: 'agroup'} )
+
+# get group record and members inf
+od.run( command: :group_info,  params: user_params )
+
+# remove a user from a group
+od.run( command: :user_remove_from_group,
+        params: {user_name: 'someone', group_name: 'agroup'})
+od.run( command: :user_remove_from_group,
+        params: {user_name: 'existinguser', group_name: 'agroup'})
+
+# delete a group
+od.run( command: :group_delete, params: {group__name: 'agroup'})
+
+# delete a user
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/open_directory_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenDirectoryUtils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_directory_utils/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open_directory_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_directory_utils.rb

@@ -0,0 +1,6 @@
+require "open_directory_utils/version"
+require "open_directory_utils/connection"
+
+module OpenDirectoryUtils
+  # Your code goes here...
+end

data/lib/open_directory_utils/clean_check.rb

@@ -0,0 +1,30 @@
+module OpenDirectoryUtils
+
+  # https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/dscl.1.html
+  # https://superuser.com/questions/592921/mac-osx-users-vs-dscl-command-to-list-user/621055?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
+  module CleanCheck
+
+    def assert(&block)
+      raise ArgumentError unless block.call
+    end
+
+    def check_critical_attribute(attrib, key, value=nil)
+      assert{not attrib[key].nil?}
+      attrib[key] = attrib[key].to_s.strip
+      assert{not attrib[key].eql? ''}
+      assert{not attrib[key].include? ' '} if key.eql? :scope
+      assert{not attrib[key].include? ' '} if [:uid, :username, :record_name].include? key
+      rescue NoMethodError, ArgumentError => error
+        message  = "#{key}: '#{attrib[key].inspect}' invalid"
+        message += ", value_name: :#{value}"  unless value.nil?
+        raise ArgumentError, message
+    end
+
+    def tidy_attribs(attribs)
+      user_attrs = {}
+      attribs.each{ |k,v| user_attrs[k] = v.to_s.strip }
+      return user_attrs
+    end
+
+  end
+end

data/lib/open_directory_utils/commands_group.rb

@@ -0,0 +1,216 @@
+require "open_directory_utils/dscl"
+require "open_directory_utils/clean_check"
+
+module OpenDirectoryUtils
+
+  # this is a long list of pre-built dscl commands affecting groups to accomplish common actions
+  # @note - these commands were derived from the following resrouces:
+  # * http://krypted.com/mac-os-x/create-groups-using-dscl/
+  # * https://apple.stackexchange.com/questions/307173/creating-a-group-via-users-groups-in-command-line?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
+  module CommandsGroup
+
+    include OpenDirectoryUtils::Dscl
+    include OpenDirectoryUtils::CleanCheck
+
+    def group_record_name_alternatives(attribs)
+      attribs[:record_name] = nil
+      attribs[:record_name] = attribs[:group_name]
+      attribs[:record_name] = attribs[:record_name] || attribs[:groupname]
+      attribs[:record_name] = attribs[:record_name] || attribs[:gid]
+      attribs[:record_name] = attribs[:record_name] || attribs[:cn]
+      return attribs
+    end
+
+    # dscl . read /Groups/ladmins
+    def group_get_info(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      check_critical_attribute( attribs, :record_name )
+
+      command = {action: 'read', scope: 'Groups', value: nil}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+    alias_method :group_info, :group_get_info
+
+    def group_exists?(attribs, dir_info)
+      group_get_info(attribs, dir_info)
+    end
+
+    # add 1st user   -- dscl . create /Groups/ladmins GroupMembership localadmin
+    # add more users -- dscl . append /Groups/ladmins GroupMembership 2ndlocaladmin
+    def group_add_first_user(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      # value = username
+      attribs[:value]     = attribs[:value] || attribs[:user_name]
+      attribs[:value]     = attribs[:value] || attribs[:username]
+      attribs[:value]     = attribs[:value] || attribs[:uid]
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :username )
+
+      # Will assume we are not adding the first user!
+      command = { action: 'create', scope: 'Groups',
+                  attribute: 'GroupMembership'}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    def group_has_user?(attribs, dir_info)
+      group_get_info(attribs, dir_info)
+    end
+
+    # add 1st user   -- dscl . create /Groups/ladmins GroupMembership localadmin
+    # add more users -- dscl . append /Groups/ladmins GroupMembership 2ndlocaladmin
+    def group_add_user(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      # value = username
+      attribs[:value]     = attribs[:value] || attribs[:user_name]
+      attribs[:value]     = attribs[:value] || attribs[:username]
+      attribs[:value]     = attribs[:value] || attribs[:uid]
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :username )
+
+      # Will assume we are not adding the first user!
+      command = { action: 'append', scope: 'Groups',
+                  attribute: 'GroupMembership'}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    # # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1/ -delete /Groups/$SHORTNAME GroupMembership $VALUE
+    # # dseditgroup -o edit -d $Username -t user $GroupName
+    def group_remove_user(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      # value <- is username
+      attribs[:value]     = attribs[:value] || attribs[:user_name]
+      attribs[:value]     = attribs[:value] || attribs[:username]
+      attribs[:value]     = attribs[:value] || attribs[:uid]
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :username )
+
+      command = { action: 'delete', scope: 'Groups',
+                  attribute: 'GroupMembership'}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    # dscl . -delete /Groups/yourGroupName
+    # https://tutorialforlinux.com/2011/09/15/delete-users-and-groups-from-terminal/
+    def group_delete(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      check_critical_attribute( attribs, :record_name )
+
+      command = {action: 'delete', scope: 'Groups', attribute: nil, value: nil}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    def group_create_min(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      check_critical_attribute( attribs, :record_name )
+
+      command = {action: 'create', scope: 'Groups', attribute: nil, value: nil}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    def group_set_primary_group_id(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      attribs[:value] = attribs[:value] || attribs[:primary_group_id]
+      attribs[:value] = attribs[:value] || attribs[:group_number]
+      attribs[:value] = attribs[:value] || attribs[:groupnumber]
+      attribs[:value] = attribs[:value] || attribs[:gidnumber]
+      attribs[:value] = attribs[:value] || attribs[:group_id]
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :group_id )
+
+      command = {action: 'create', scope: 'Groups', attribute: 'PrimaryGroupID'}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    def group_set_real_name(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      attribs[:value] = attribs[:value] || attribs[:real_name]
+      attribs[:value] = attribs[:value] || attribs[:long_name]
+      attribs[:value] = attribs[:value] || attribs[:longname]
+      attribs[:value] = attribs[:value] || attribs[:full_name]
+      attribs[:value] = attribs[:value] || attribs[:fullname]
+      attribs[:value] = attribs[:value] || attribs[:name]
+      attribs[:value] = attribs[:value] || attribs[:group_name]
+      attribs[:value] = attribs[:value] || attribs[:groupname]
+      attribs[:value] = attribs[:value] || attribs[:gid]
+      attribs[:value] = attribs[:value] || attribs[:cn]
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :real_name )
+
+      command = {action: 'create', scope: 'Groups', attribute: 'RealName'}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+
+    # probably can't create password for group?
+    # /usr/bin/dscl -u diradmin -P liaP-meD-Aj-pHi-hOb-en-c /LDAPv3/127.0.0.1/ -create /Groups/odgrouptest passwd "*"
+    #  "<main> attribute status: eDSNoStdMappingAvailable\n" +
+    #  "<dscl_cmd> DS Error: -14140 (eDSNoStdMappingAvailable)"]
+    def group_set_passwd(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      attribs[:value] = attribs[:value] || attribs[:password]
+      attribs[:value] = attribs[:value] || attribs[:passwd]
+      attribs[:value] = attribs[:value] || '*'
+
+      check_critical_attribute( attribs, :record_name )
+      check_critical_attribute( attribs, :value, :password )
+
+      command = {action: 'passwd', scope: 'Groups', attribute: nil}
+      user_attrs = attribs.merge(command)
+
+      dscl( user_attrs, dir_info )
+    end
+    alias_method :group_set_password, :group_set_passwd
+
+    # create group     -- dscl . -create /Groups/ladmins
+    # add group passwd -- dscl . -create /Groups/ladmins passwd “*”
+    # add group name   -- dscl . -create /Groups/ladmins RealName “Local Admins”
+    # group ID number  -- dscl . -create /Groups/ladmins gid 400
+    # group id number  -- dscl . -create /Groups/GROUP PrimaryGroupID GID
+    def group_create_full(attribs, dir_info)
+      attribs = group_record_name_alternatives(attribs)
+
+      answer          = []
+      attribs[:value] = nil
+      answer         << group_create_min( attribs, dir_info )
+      attribs[:value] = nil
+      answer         << group_set_primary_group_id( attribs, dir_info )
+      attribs[:value] = nil
+      answer         << group_set_real_name( attribs, dir_info )
+      # attribs[:value] = nil
+      # answer         << group_set_password( attribs, dir_info )
+
+      return answer
+    end
+    alias_method :group_create, :group_create_full
+
+  end
+end