activesambaldap 0.0.1

data/NEWS.en

@@ -0,0 +1,9 @@
+# -*- rd -*-
+
+= NEWS.en
+
+$Id: NEWS.en 54 2006-11-17 07:49:27Z kou $
+
+== 0.0.1: 2006-11-17
+
+  * Initial release.

data/NEWS.ja

@@ -0,0 +1,10 @@
+# -*- rd -*-
+
+= NEWS.ja
+
+$Id: NEWS.ja 54 2006-11-17 07:49:27Z kou $
+
+== 0.0.1: 2006-11-17
+
+  * 最初のリリース．
+

data/README.en

@@ -0,0 +1,310 @@
+# -*- rd -*-
+
+= README.en
+
+$Id: README.en 56 2006-11-17 08:40:26Z kou $
+
+== Name
+
+ActiveSambaLdap
+
+== What's this?
+
+ActiveSambaLdap is a library and a management tool for Samba +
+LDAP environment.
+
+ActiveSambaLdap provides object-oriented API to manipulate
+LDAP entry for Samba. ActiveSambaLdap also provides
+command-line tools to replace smbldap-tools written by Perl.
+
+== Author
+
+Kouhei Sutou <kou@cozmixng.org>
+
+== Licence
+
+Ruby's.
+
+== Mailing list
+
+asl-devel@rubyforge.org
+
+== Reference manual
+
+((<URL:http://asl.rubyforge.org/>))
+
+== Dependency libraries
+
+  * ActiveLdap >= 0.8.0: not released
+
+== Usage
+
+=== Use with Rails
+
+First, install ActiveSambaLdap plugin for Rails. And modify
+the following URL because the URL is for trunk.
+
+  % script/plugin install svn://rubyforge.org/var/svn/asl/trunk/rails/plugin/active_samba_ldap
+
+Next, scaffold the environment of ActiveSambaLdap for Rails.
+
+  % script/generate scaffold_asl
+
+Modify config/ldap.yml generated by scaffold_asl to adapt
+to your environment. See "Options in configuration file"
+section to find available options.
+
+==== Populate
+
+First, need to populate your Samba + LDAP environment.
+Access http://localhost:3000/samba after invoking Rails by
+script/server and so on. And populate your Samba + LDAP
+environment by following "Populate Samba + LDAP environment"
+link.
+
+And you can development your applications with
+User/Computer/Group classes. You can develop like with
+ActiveRecord.
+
+=== Use from command line
+
+Use asl-* commands. You'll don't use asl-samba-* commands
+from command line because they are for smb.conf.
+
+==== Configuration
+
+First, modify configuration file to adapt to your
+environment. You can confirm default configuration files by
+invoking asl-* commands with --help option. For example, you
+can use asl-populate.
+
+  % asl-populate --help
+  ...
+        --config=CONFIG              Specify configuration file
+                                     Default configuration files:
+                                       /etc/activesambaldap/config.yaml
+                                       /etc/activesambaldap/bind.yaml
+                                       /home/kou/.activesambaldap.conf
+                                       /home/kou/.activesambaldap.bind
+  ...
+
+Configuration files are read from the above files to the
+below files. Configurations are overridden by latter
+configuration files. In the above example, configuration
+files are read by the following order:
+
+  * /etc/activesambaldap/config.yaml
+  * /etc/activesambaldap/bind.yaml
+  * /home/kou/.activesambaldap.conf
+  * /home/kou/.activesambaldap.bind
+
+The reason why bind.yaml and *.bind are read after
+config.yaml and *.conf is for security. You should write
+opened configurations (host name, port number and so on)
+into config.yaml and *.conf, closed configurations (user
+name, password and so on) into bind.yaml and *.bind. And you
+should set suitable permission to bind.yaml and *.bind.
+
+==== Format of configuration file
+
+Use YAML format. There are three sections:
+
+  update:
+    # configurations for updating LDAP entries
+    ...
+
+  reference:
+    # configurations for referring LDAP entries
+    ...
+
+  common:
+    # configurations to share for updating/referring
+    ...
+
+For example:
+
+  common:
+    sid: S-1-5-21-915876905-2926214379-2876160357
+    base: dc=samba,dc=local,dc=net
+    host: localhost
+    method: :tls
+
+  update:
+    bind_dn: cn=admin,dc=local,dc=net
+    password: admin
+
+  reference:
+    allow_anonymous: true
+
+It's best that you write 'password' configuration into
+bind.yaml *.bind.
+
+You must configure 'base'. And you should configure
+'sid'. You can find your SID by the following command:
+
+  % sudo net getlocalsid
+
+It's inefficiency that sid isn't configured because 'net
+getlocalsid' is invoked each time.
+
+==== Options in configuration file
+
+The following options are available:
+
+: base
+   Same as the option of ActiveLdap::Base.establish_connection.
+: host
+   Same as the option of ActiveLdap::Base.establish_connection.
+: port
+   Same as the option of ActiveLdap::Base.establish_connection.
+: scope
+   Same as the option of ActiveLdap::Base.establish_connection.
+: bind_dn
+   Same as the option of ActiveLdap::Base.establish_connection.
+: password
+   Same as the option of ActiveLdap::Base.establish_connection.
+: method
+   Same as the option of ActiveLdap::Base.establish_connection.
+: allow_anonymous
+   Same as the option of ActiveLdap::Base.establish_connection.
+
+: sid
+   SID(Security Identifier) of your Samba server.
+: smb_conf
+   The path of smb.conf for your Samba server.
+: samba_domain
+   Domain name of your Samba server.
+: samba_netbios_name
+   NetBIOS name of your Samba server.
+
+: password_hash_type
+   Algorithm for hashing password in LDAP. Available
+   algorithms are :crypt, :md5, :smd5, :sha and
+   :ssha. Default algorithm is :ssha.
+
+   Password in LDAP is used for recognition in UNIX not Samba.
+
+: users_suffix
+   Tree for user entries in LDAP. Specify relative path for
+   base. For example: ou=Users
+: groups_suffix
+   Tree for group entries in LDAP. Specify relative path for
+   base. For example: ou=Groups
+: computers_suffix
+   Tree for computer entries in LDAP. Specify relative path for
+   base. For example: ou=Computers
+: idmap_suffix
+   Tree for idmap entries in LDAP. Specify relative path for
+   base. For example: ou=Idmap
+
+: start_uid
+   UID (User Identifier) for making new user. Next new
+   user's default UID is incremented after making new
+   user. Default is 10000.
+
+: start_gid
+   GID (Group Identifier) for making new group. Next new
+   group's default GID is incremented after making new
+   group. Default is 10000.
+
+: user_login_shell
+   Default login shell for new user. Default is /bin/false.
+: user_home_directory
+   Default home directory for new user. %U is substituted
+   with the user name. Default is /home/%U.
+: user_home_directory_mode
+   Default permission of user's home directory. Default is
+   0755 (octal notation).
+
+: user_gecos
+   Default GECOS field value for new user. %U is substituted
+   with user name.
+
+: user_home_unc
+   Default path for user's home in Windows. The path should
+   be specified by UNC (Universal Naming Convention). %U is
+   substituted with user name. Default is "\\NetBIOS name
+   of your Samba server\%U".
+
+: user_profile
+   Default path of user profile specified by
+   UNC (Universal Naming Convention). %U is substituted by
+   the user name. Default is "\\NetBIOS name Samba
+   server\profiles\%U".
+
+: user_home_drive
+   Default drive name of user's home. Default is H:.
+
+: user_logon_script
+   Default script name that is invoked when user
+   logon. Default is logon.bat.
+
+# : mail_domain
+
+: skeleton_directory
+   Default skeleton directory for making user's home
+   directory. Default is /etc/skel.
+
+: default_user_gid
+   Default GID of group to which user belongs. Default is
+   'Domain Users' group.
+
+: default_computer_gid
+   Default GID of group to which computer belongs. Default
+   is 'Domain Computers' group.
+
+# : default_max_password_age
+
+==== Populate
+
+You need to populate your Samba + LDAP environment by
+invoking asl-populate before administrate your Samba + LDAP
+with asl-*.
+
+  % sudo asl-populate
+
+You can use the following command if you don't need to root
+authorization((-root authorization check may be needed...-)).
+
+  % fakeroot asl-populate
+
+==== Administrate
+
+Use asl-user*, asl-group*, asl-populate,
+asl-purge and asl-password. Use --help options for more detail.
+
+==== Configuration of smb.conf
+
+You need to configure you smb.conf like the following if you
+want to administrate with
+((<Srvtools|URL:http://support.microsoft.com/kb/173673/>))
+from Windows or make Samba server domain controller.
+Use asl-samba-* for those propose.
+
+  passdb backend = ldapsam:ldap://127.0.0.0
+  ldap admin dn = cn=admin,dc=local,dc=net
+  ldap suffix = dc=samba,dc=local,dc=net
+  ldap user suffix = ou=Users
+  ldap group suffix = ou=Groups
+  ldap machine suffix = ou=Computers
+  ldap idmap suffix = ou=Idmap
+  ldap passwd sync = yes
+
+  admin users = "@Domain Admins"
+  add user script = /.../asl-samba-useradd "%u"
+  delete user script = /.../asl-samba-userdel "%u"
+  add group script = /.../asl-samba-groupadd "%g"
+  delete group script = /.../asl-samba-groupdel "%g"
+  add user to group script = /.../asl-samba-groupmod "%g" --add-members "%u"
+  delete user from group script = /.../asl-samba-groupmod "%g" --delete-members "%u"
+  set primary group script = /.../asl-samba-usermod "%u" --gid "%g"
+  add machine script = /.../asl-samba-computeradd "%u"
+
+You need to set LDAP administrator password by the following
+command before invoke your Samba server.
+
+  % sudo /usr/bin/smbpasswd -W
+
+== Trouble shootings
+
+== Thanks

data/README.ja

@@ -0,0 +1,307 @@
+# -*- rd -*-
+
+= README.ja
+
+$Id: README.ja 56 2006-11-17 08:40:26Z kou $
+
+== 名前
+
+ActiveSambaLdap
+
+== なにこれ？
+
+ActiveSambaLdapはSamba用LDAPエントリを管理するための
+ActiveRecord風なライブラリです．また，smbldap-toolsのような
+管理用コマンドラインツールも提供します．
+
+== 作者
+
+Kouhei Sutou <kou@cozmixng.org>
+
+== ライセンス
+
+Ruby's.
+
+== メーリングリスト
+
+asl-devel-ja@rubyforge.org
+
+== リファレンスマニュアル
+
+((<URL:http://asl.rubyforge.org/>))
+
+== 依存ライブラリ
+
+  * ActiveLdap >= 0.8.0: 未リリース
+
+== 使用法
+
+=== Railsと使う
+
+まず，Rails用プラグインをインストールします．以下のURLは
+trunk用ですので，環境にあわせて変更してください．
+
+  % script/plugin install svn://rubyforge.org/var/svn/asl/trunk/rails/plugin/active_samba_ldap
+
+次に，Rails用ActiveSambaLdap環境を構築します．
+
+  % script/generate scaffold_asl
+
+config/ldap.ymlが生成されるので，環境にあわせて編集します．
+指定できるオプションは，以下の「設定ファイルのオプション」の
+項を参考にしてください．
+
+==== 初期化
+
+はじめに，Samba + LDAP環境を初期化する必要があります．
+script/serverなどでRailsを起動し，
+http://localhost:3000/sambaにアクセスしてください．
+「Populate Samba + LDAP environment」というリンクがあるので，
+それを使ってSamba + LDAP環境を初期化します．
+
+あとは，ActiveRecordを利用した開発と同じように，
+User/Computer/Groupクラスなどを使用して開発してください．
+
+=== コマンドラインから使う
+
+asl-*というコマンドを使います．asl-samba-*はsmb.confに設定す
+るためのコマンドで，ターミナルから使うことはありません．
+
+==== 設定
+
+まず，あなたの環境にあわせて設定ファイルを編集します．デフォ
+ルトで読み込まれるファイルは--helpオプションをつけて起動する
+と確認できます．asl-*のどのコマンドでも表示されます．例えば，
+asl-populateを使うとこうなります．
+
+  % asl-populate --help
+  ...
+        --config=CONFIG              Specify configuration file
+                                     Default configuration files:
+                                       /etc/activesambaldap/config.yaml
+                                       /etc/activesambaldap/bind.yaml
+                                       /home/kou/.activesambaldap.conf
+                                       /home/kou/.activesambaldap.bind
+  ...
+
+設定ファイルは上から順に読み込まれていきます．設定内容は後の
+ファイルで上書きされます．上記の例だと，以下の順序で読み込ま
+れていきます．
+
+  * /etc/activesambaldap/config.yaml
+  * /etc/activesambaldap/bind.yaml
+  * /home/kou/.activesambaldap.conf
+  * /home/kou/.activesambaldap.bind
+
+config.yamlや*.confの後にbind.yamlや*.bindを読み込んでいるの
+はセキュリティ上の配慮です．ホスト名などの見られてもよい情報
+はconfig.yamlや*.confに書き，認証情報など見られてはまずい情
+報はbind.yamlや*.bindに書き，適切なパーミッションを設定する
+とよいでしょう．
+
+==== 設定ファイルの書式
+
+YAMLで記述します．三つのセクションからなります．
+
+  update:
+    # LDAPエントリを更新する時の設定
+    ...
+
+  reference:
+    # LDAPエントリを参照する時の設定
+    ...
+
+  common:
+    # 更新時／参照時で共有の設定
+    ...
+
+例えば，以下のようになります．
+
+  common:
+    sid: S-1-5-21-915876905-2926214379-2876160357
+    base: dc=samba,dc=local,dc=net
+    host: localhost
+    method: :tls
+
+  update:
+    bind_dn: cn=admin,dc=local,dc=net
+    password: admin
+
+  reference:
+    allow_anonymous: true
+
+passwordはbind.yamlや*.bindに記述するとよいでしょう．
+
+baseは必ず設定してください．また，sidも設定しておくとよいで
+しょう．sidの値は以下のコマンドで確認できます．
+
+  % sudo net getlocalsid
+
+sidを設定しておかないと，毎回net getlocalsidをするため，効率
+が悪くなります．
+
+==== 設定ファイルのオプション
+
+設定可能なオプションは以下の通りです．
+
+: base
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: host
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: port
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: scope
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: bind_dn
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: password
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: method
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+: allow_anonymous
+   ActiveLdap::Base.establish_connectionのオプションと同じ．
+
+: sid
+   SambaサーバのSID(Security Identifier)．
+: smb_conf
+   Sambaの設定ファイルsmb.confがあるパス．
+: samba_domain
+   Sambaサーバのドメイン
+: samba_netbios_name
+   SambaサーバのNetBIOS名
+
+: password_hash_type
+   LDAP上のパスワードをハッシュ化する時に使用するアルゴリズ
+   ム．指定できるのは:crypt, :md5, :smd5, :sha, :sshaで，デ
+   フォルトは:sshaです．
+
+   LDAP上のパスワードはSambaの認証時ではなく，UNIX上のユーザ
+   の認証時に利用されます．
+
+: users_suffix
+   LDAP上のユーザエントリを格納するツリー．baseからの相対パ
+   スを指定する．例: ou=Users
+: groups_suffix
+   LDAP上のグループエントリを格納するツリー．baseからの相対パ
+   スを指定する．例: ou=Groups
+: computers_suffix
+   LDAP上のコンピュータエントリを格納するツリー．baseからの相対パ
+   スを指定する．例: ou=Computers
+: idmap_suffix
+   LDAP上のidmapエントリを格納するツリー．baseからの相対パ
+   スを指定する．例: ou=Idmap
+
+: start_uid
+   新しいユーザを作ったときに，はじめに使用するUID(User
+   Identifier)．以降のUIDは1ずつ増えていく．デフォルトは
+   10000．
+
+: start_gid
+   新しいユーザを作ったときに，はじめに使用するGID(Group
+   Identifier)．以降のGIDは1ずつ増えていく．デフォルトは
+   10000．
+
+: user_login_shell
+   新しく作成したユーザのログインシェル．デフォルトは
+   /bin/false．
+: user_home_directory
+   新しく作成したユーザのホームディレクトリ．%Uはユーザ名に
+   置換される．デフォルトは/home/%U．
+: user_home_directory_mode
+   ユーザのホームディレクトリを作成する際に設定するパーミッ
+   ション用のモード．デフォルトは0755（8進数）．
+
+: user_gecos
+   ユーザのGECOSフィールドの値．%Uはユーザ名に置換される．
+
+: user_home_unc
+   Windowsから見たときのユーザのホームへのパス．
+   UNC(Universal Naming Convention)で記述する．%Uはユーザ名
+   に置換される．デフォルトは\\SambaサーバのNetBIOS名\%U．
+
+: user_profile
+   ユーザプロファイルへのパス．
+   UNC(Universal Naming Convention)で記述する．%Uはユーザ名
+   に置換される．デフォルトは\\SambaサーバのNetBIOS名\profiles\%U．
+
+: user_home_drive
+   ユーザのホームを割り当てるドライブ名．デフォルトはH:．
+
+: user_logon_script
+   ユーザがログオンしたときに実行するスクリプトファイル名．
+   デフォルトはlogon.bat．
+
+# : mail_domain
+
+: skeleton_directory
+   ユーザのホームディレクトリを作成する時に雛型とするディレ
+   クトリ．デフォルトは/etc/skel．
+
+: default_user_gid
+   デフォルトでユーザが所属するグループ．デフォルトはDomain
+   Usersグループ．
+
+: default_computer_gid
+   デフォルトでコンピュータが所属するグループ．デフォルトは
+   Domain Computersグループ．
+
+# : default_max_password_age
+
+==== 初期化
+
+asl-*を用いてSamba + LDAP環境を管理する前に，一度だけ
+asl-populateを起動してLDAPサーバに基本的なエントリを追加しま
+す．
+
+  % sudo asl-populate
+
+もし，root権限が無くても実行できるのであれば以下のようにする
+とよいでしょう((-root権限チェックは必要ないかもしれない-))．
+
+  % fakeroot asl-populate
+
+==== 管理
+
+コマンドラインからはasl-user*, asl-group*, asl-populate,
+asl-purge, asl-passwordを使って管理してください．各コマンド
+の使いかたは--helpオプションを参考にしてください．
+
+==== smb.confの設定
+
+((<Srvtools|URL:http://support.microsoft.com/kb/173673/>))を
+使ってWindowsからユーザ管理を行いたい場合は，また，Sambaをド
+メインコントローラとして動作させたい場合は，以下のように
+smb.confを設定します．ここでは，asl-samba-*を使います．
+
+（ドメインコントローラとして動作させるけど，Srvtools でユー
+ザ管理を行わない場合はadd machine script以外のなんとかscript
+は設定しなくてもよい気がする．）
+
+  passdb backend = ldapsam:ldap://127.0.0.0
+  ldap admin dn = cn=admin,dc=local,dc=net
+  ldap suffix = dc=samba,dc=local,dc=net
+  ldap user suffix = ou=Users
+  ldap group suffix = ou=Groups
+  ldap machine suffix = ou=Computers
+  ldap idmap suffix = ou=Idmap
+  ldap passwd sync = yes
+
+  admin users = "@Domain Admins"
+  add user script = /.../asl-samba-useradd "%u"
+  delete user script = /.../asl-samba-userdel "%u"
+  add group script = /.../asl-samba-groupadd "%g"
+  delete group script = /.../asl-samba-groupdel "%g"
+  add user to group script = /.../asl-samba-groupmod "%g" --add-members "%u"
+  delete user from group script = /.../asl-samba-groupmod "%g" --delete-members "%u"
+  set primary group script = /.../asl-samba-usermod "%u" --gid "%g"
+  add machine script = /.../asl-samba-computeradd "%u"
+
+Sambaを起動する前に，以下を実行してldap admin dnで指定した
+LDAP管理ユーザのパスワードを設定しておく必要があります．
+
+  % sudo /usr/bin/smbpasswd -W
+
+== トラブルシューティング
+
+
+== 感謝