JAAS承認チュートリアル

ポリシー・ファイルgrant文(デフォルトのPolicyの実装とポリシー・ファイルの構文を参照)に、1つ以上のPrincipalフィールドをオプションで含めることができるようになりました。Principalフィールドは、指定されたPrincipalで表される(指定されたコードを実行する)ユーザーまたはその他のエンティティが、特定のアクセス権を保持することを表します。

このため、grant文の基本的な書式は次のようになります

grant <signer(s) field>, <codeBase URL> 
  <Principal field(s)> {
    permission perm_class_name "target_name", "action";
    ....
    permission perm_class_name "target_name", "action";
  };

signer、codeBaseおよびPrincipalの各フィールドはオプションであり、各フィールドの順序は重要ではありません。

Principalフィールドは、次のようになります。

Principal Principal_class "principal_name"

つまり、Principalという語(大文字、小文字は区別されない)に続き、完全修飾のPrincipalクラス名およびプリンシパル名を指定します。

Principalクラスは、java.security.Principalインタフェースを実装するクラスです。すべてのPrincipalオブジェクトは、getNameメソッドの呼出しによって取得できる関連名を持っています。名前に使用される書式は、Principal実装によって異なります。

このチュートリアルで使用する、基本認証メカニズムにより作成されるSubject内に配置されるPrincipalのタイプは、SamplePrincipalであるため、これをgrant文のPrincipalの指定のPrincipal_class部分で使用してください。SamplePrincipalのユーザー名はnameの形式になります。このチュートリアルで使用可能なユーザー名はtestUserのみです。したがって、grant文で使用するprincipal_nameの指定はtestUserです。

単一のgrant文内に複数のPrincipalフィールドを含めることも可能です。複数のPrincipalフィールドを指定する場合、現在のアクセス制御コンテキストに関連付けられたSubjectにこれらのPrincipalのすべてが含まれる場合にのみ、grant文のアクセス権が付与されます。

複数のPrincipalに同じアクセス権のセットを付与するには、複数のgrant文を作成し、各文にアクセス権のリストといずれかのPrincipalを指し示す単一のPrincipalフィールドを含めます。

このチュートリアルのポリシー・ファイルでは、Principalフィールドに1つのgrant文が含まれます。

grant codebase "file:./SampleAction.jar",
        Principal sample.principal.SamplePrincipal "testUser" {

   permission java.util.PropertyPermission "java.home", "read";
   permission java.util.PropertyPermission "user.home", "read";
   permission java.io.FilePermission "foo.txt", "read";
};

これは、指定したアクセス権を、SampleAction.jar内のコードを実行する指定されたPrincipalに付与することを示します。(注意: SamplePrincipalクラスはsample.principalパッケージ内にあります。)

サブジェクトを作成し、現在のアクセス制御コンテキストに関連付けるには、次のようにします。

• 最初にユーザーを認証する必要があります(JAAS認証チュートリアルを参照)。
• SubjectクラスのstaticメソッドdoAsを呼び出し、認証されたSubjectとjava.security.PrivilegedActionまたはjava.security.PrivilegedExceptionActionを渡します。(PrivilegedActionとPrivilegedExceptionActionの相違点については、JDKでのアクセス権の付録A: 特権ブロックのためのAPIを参照してください。)doAsメソッドは、提供されたサブジェクトを現在のアクセス制御コンテキストに関連付け、アクションからrunメソッドを呼び出します。runメソッド実装には、指定されたサブジェクトとして実行されるすべてのコードが含まれています。このため、アクションは指定されたサブジェクトとして実行されます。

  このチュートリアルで実行するように、doAsメソッドの代わりに、SubjectクラスのdoAsPrivileged staticメソッドを呼び出すことができます。doAsPrivilegedは、doAsに渡されるパラメータの他に3番目のパラメータAccessControlContextを必要とします。doAsPrivilegedは、指定されたSubjectを現在のアクセス制御コンテキストに関連付けるdoAsと異なり、Subjectを、指定されたアクセス制御コンテキストまたは、このチュートリアルの場合のように、渡されたパラメータがnullの場合は空のアクセス制御コンテキストに関連付けます。これらのメソッドの相違点については、『JAASリファレンス・ガイド』の「doAsとdoAsPrivileged」を参照してください。

SampleAcnと同様に、SampleAznクラスはLoginContext lcをインスタンス化し、loginメソッドを呼び出して認証を実行します。認証に成功した場合は、LoginContextのgetSubjectメソッドを呼び出すことにより、認証されたサブジェクト(ユーザーを表すSamplePrincipalを含む)を取得します。

Subject mySubject = lc.getSubject();

mainメソッドは、サブジェクトに関する情報(たとえばそのサブジェクトのプリンシパル情報)をユーザーに提供した後、Subject.doAsPrivilegedを呼び出し、次に示すように、認証されたサブジェクトmySubject、PrivilegedAction (SampleAction)およびnull AccessControlContextを渡します。

SampleActionクラスは、次の方法でインスタンス化されます。

PrivilegedAction action = new SampleAction();

Subject.doAsPrivilegedの呼出しは、次の方法で行われます。

Subject.doAsPrivileged(mySubject, action, null);

doAsPrivilegedメソッドは、PrivilegedAction action (SampleAction)のrunメソッドを呼び出して、サブジェクトmySubjectのかわりの実行と見なされる残りのコードの実行を開始します。

3番目のAccessControlContext引数としてdoAsPrivilegedにnullを渡すことにより、mySubjectが新しい空のAccessControlContextに関連付けられることを示します。その結果、SampleActionの実行時のセキュリティ・チェックでは、mySubjectとして実行されるSampleActionコード自体(またはこのコードによって呼び出されるその他のコード)のアクセス権のみが必要になります。doAsPrivilegedの呼出し側(およびdoAsPrivilegedが呼び出された時点で実行スタック上に存在していた呼出し側)は、アクションが実行されている間、アクセス権を必要としません。

package sample;

import java.io.*;
import java.util.*;
import java.security.Principal;
import java.security.PrivilegedAction;
import javax.security.auth.*;
import javax.security.auth.callback.*;
import javax.security.auth.login.*;
import javax.security.auth.spi.*;
import com.sun.security.auth.*;

/**
 * This Sample application attempts to authenticate a user
 * and executes a SampleAction as that user.
 *
 * If the user successfully authenticates itself,
 * the username and number of Credentials is displayed.
 */
public class SampleAzn {

    /**
     * Attempt to authenticate the user.
     *
     * @param args input arguments for this application.  These are ignored.
     */
     public static void main(String[] args) {

        // Obtain a LoginContext, needed for authentication. Tell it
        // to use the LoginModule implementation specified by the
        // entry named "Sample" in the JAAS login configuration
        // file and to also use the specified CallbackHandler.
        LoginContext lc = null;
        try {
            lc = new LoginContext("Sample", new MyCallbackHandler());
        } catch (LoginException le) {
            System.err.println("Cannot create LoginContext. "
                + le.getMessage());
            System.exit(-1);
        } catch (SecurityException se) {
            System.err.println("Cannot create LoginContext. "
                + se.getMessage());
            System.exit(-1);
        }

        // the user has 3 attempts to authenticate successfully
        int i;
        for (i = 0; i < 3; i++) {
            try {

                // attempt authentication
                lc.login();

                // if we return with no exception, authentication succeeded
                break;

            } catch (LoginException le) {

                  System.err.println("Authentication failed:");
                  System.err.println("  " + le.getMessage());
                  try {
                      Thread.currentThread().sleep(3000);
                  } catch (Exception e) {
                      // ignore
                  }

            }
        }

        // did they fail three times?
        if (i == 3) {
            System.out.println("Sorry");
            System.exit(-1);
        }

        System.out.println("Authentication succeeded!");

        Subject mySubject = lc.getSubject();

        // let's see what Principals we have
        Iterator principalIterator = mySubject.getPrincipals().iterator();
        System.out.println("Authenticated user has the following Principals:");
        while (principalIterator.hasNext()) {
            Principal p = (Principal)principalIterator.next();
            System.out.println("\t" + p.toString());
        }

        System.out.println("User has " +
                        mySubject.getPublicCredentials().size() +
                        " Public Credential(s)");

        // now try to execute the SampleAction as the authenticated Subject
        PrivilegedAction action = new SampleAction();
        Subject.doAsPrivileged(mySubject, action, null);

        System.exit(0);
    }
}

/**
 * A CallbackHandler implemented by the application.
 *
 * This application is text-based.  Therefore it displays information
 * to the user using the OutputStreams System.out and System.err,
 * and gathers input from the user using the InputStream System.in.
 */
class MyCallbackHandler implements CallbackHandler {

    /**
     * Invoke an array of Callbacks.
     *
     * @param callbacks an array of <code>Callback</code> objects which contain
     *                  the information requested by an underlying security
     *                  service to be retrieved or displayed.
     *
     * @exception java.io.IOException if an input or output error occurs. <p>
     *
     * @exception UnsupportedCallbackException if the implementation of this
     *                  method does not support one or more of the Callbacks
     *                  specified in the <code>callbacks</code> parameter.
     */
    public void handle(Callback[] callbacks)
    throws IOException, UnsupportedCallbackException {

        for (int i = 0; i < callbacks.length; i++) {
            if (callbacks[i] instanceof TextOutputCallback) {

                // display the message according to the specified type
                TextOutputCallback toc = (TextOutputCallback)callbacks[i];
                switch (toc.getMessageType()) {
                case TextOutputCallback.INFORMATION:
                    System.out.println(toc.getMessage());
                    break;
                case TextOutputCallback.ERROR:
                    System.out.println("ERROR: " + toc.getMessage());
                    break;
                case TextOutputCallback.WARNING:
                    System.out.println("WARNING: " + toc.getMessage());
                    break;
                default:
                    throw new IOException("Unsupported message type: " +
                                        toc.getMessageType());
                }

            } else if (callbacks[i] instanceof NameCallback) {

                // prompt the user for a username
                NameCallback nc = (NameCallback)callbacks[i];

                System.err.print(nc.getPrompt());
                System.err.flush();
                nc.setName((new BufferedReader
                        (new InputStreamReader(System.in))).readLine());

            } else if (callbacks[i] instanceof PasswordCallback) {

                // prompt the user for sensitive information
                PasswordCallback pc = (PasswordCallback)callbacks[i];
                System.err.print(pc.getPrompt());
                System.err.flush();
                pc.setPassword(System.console().readPassword());

            } else {
                throw new UnsupportedCallbackException
                        (callbacks[i], "Unrecognized Callback");
            }
        }
    }
}

SampleAction.javaには、SampleActionクラスが含まれます。このクラスは、java.security.PrivilegedActionを実装し、サブジェクトmySubjectとして実行するすべてのコードを含むrunメソッドを持ちます。このチュートリアルでは、3つの操作を実行します。それぞれ、コードに必要なアクセス権を付与しないかぎり、実行できません。次を実行します。

• java.homeシステム・プロパティの値を読み取り、出力する。
• user.homeシステム・プロパティの値を読み取り、出力する。
• 現行のディレクトリにfoo.txtという名前のファイルが存在するかどうかを確認する。

次に、コードを示します。

package sample;

import java.io.File;
import java.security.PrivilegedAction;

/**
 * This is a Sample PrivilegedAction implementation, designed to be
 * used with the Sample application.
 *
 */
public class SampleAction implements PrivilegedAction {

    /**
     * This Sample PrivilegedAction performs the following operations:
     * <ul>
     *   <li>Access the System property, <i>java.home</i></li>
     *   <li> Access the System property, <i>user.home</i></li>
     *   <li> Access the file, <i>foo.txt</i></li>
     * </ul>
     *
     * @return <code>null</code> in all cases.
     *
     * @exception SecurityException if the caller does not have permission
     *          to perform the operations listed above.
     */
    public Object run() {
        System.out.println("\nYour java.home property: "
                            +System.getProperty("java.home"));

        System.out.println("\nYour user.home property: "
                            +System.getProperty("user.home"));

        File f = new File("foo.txt");
        System.out.print("\nfoo.txt does ");
        if (!f.exists())
            System.out.print("not ");
        System.out.println("exist in the current working directory.");
        return null;
    }
}

SampleAznクラスのmainメソッドは、アクセス権の必要な2つの操作を実行します。次を実行します

• LoginContextの作成。
• SubjectクラスのdoAsPrivileged staticメソッドの呼出し。

LoginContextの作成方法は認証チュートリアルの場合とまったく同じとなるため、createLoginContext.Sampleをターゲットとする同じjavax.security.auth.AuthPermissionアクセス権が必要です。

SubjectクラスのdoAsPrivilegedメソッドを呼び出すには、doAsPrivilegedをターゲットとするjavax.security.auth.AuthPermissionが必要です。

SampleAznクラスが、SampleAzn.jarという名前のJARファイルに配置されている場合を考えましょう。ポリシー・ファイル内の次のgrant文を使用して、これらのアクセス権をSampleAznコードに付与できます。

grant codebase "file:./SampleAzn.jar" {
   permission javax.security.auth.AuthPermission 
                    "createLoginContext.Sample";
   permission javax.security.auth.AuthPermission "doAsPrivileged";
};

SampleActionコードは、アクセス権の必要な3つの操作を実行します。次を実行します

• java.homeシステム・プロパティの値の読取り。
• user.homeシステム・プロパティの値の読取り。
• 現行のディレクトリにfoo.txtという名前のファイルが存在するかどうかの確認。

これらの操作には、次のアクセス権が必要です。

permission java.util.PropertyPermission "java.home", "read";
permission java.util.PropertyPermission "user.home", "read";
permission java.io.FilePermission "foo.txt", "read";

これらのアクセス権をSampleAction.classのコードに付与する必要があります。これは、SampleAction.jarという名前のJARファイル内に配置されます。ただし、この特定のgrant文の場合、アクセス権をコードだけではなく、コードを実行する特定のユーザーにも付与することにより、アクセスを特定のユーザーに限定する方法を示します。

このため、「プリンシパルベースのポリシー・ファイル文の作成方法」で説明したように、grant文は次のようになります。

grant codebase "file:./SampleAction.jar", Principal sample.principal.SamplePrincipal "testUser" {
    permission java.util.PropertyPermission "java.home", "read";
    permission java.util.PropertyPermission "user.home", "read";
    permission java.io.FilePermission "foo.txt", "read";
};

SampleLoginModuleコードは、アクセス権の必要な操作を1つ実行します。SubjectにPrincipalを追加するには、modifyPrincipalsをターゲットとするjavax.security.auth.AuthPermissionが必要です。grant文は次のようになります。

grant codebase "file:./SampleLM.jar" {
    permission javax.security.auth.AuthPermission "modifyPrincipals";
};

完全なポリシー・ファイルは、sampleazn.policyです。

/* grant the sample LoginModule permissions */

grant codebase "file:./SampleAction.jar", Principal sample.principal.SamplePrincipal "testUser" {
    permission java.util.PropertyPermission "java.home", "read";
    permission java.util.PropertyPermission "user.home", "read";
    permission java.io.FilePermission "foo.txt", "read";
};

grant codebase "file:./SampleLM.jar" {
    permission javax.security.auth.AuthPermission "modifyPrincipals";
};

grant codebase "file:./SampleAcn.jar" {
   permission javax.security.auth.AuthPermission "createLoginContext.Sample";
};

JAAS承認チュートリアル・コードを実行するには、次の操作を行う必要があります。

1. 次のファイルを1つのディレクトリ内に格納します。

   • sample_jaas.configログイン構成ファイル(JAAS承認チュートリアルのログイン構成ファイルを参照)
   • sampleazn.policyポリシー・ファイル

2. 最上位ディレクトリの下にsampleという名前のサブディレクトリを作成し、ここに次のファイルを格納します(注: SampleAznおよびSampleActionクラスはsampleパッケージ内にある)。

   • SampleAzn.javaソース・ファイル
   • SampleAction.javaソース・ファイル

3. sampleディレクトリのサブディレクトリを作成し、moduleという名前を付けます。ここに次のものを格納します(注: SampleLoginModuleクラスはsample.moduleパッケージ内にある)。

   • SampleLoginModule.javaソース・ファイル

4. sampleディレクトリのサブディレクトリをもう1つ作成し、principalという名前を付けます。ここに次のものを格納します(注: SamplePrincipalクラスはsample.principalパッケージ内にある)。

   • SamplePrincipal.javaソース・ファイル

5. 最上位のディレクトリですべてのソース・ファイルをコンパイルします。

   javac sample/SampleAction.java sample/SampleAzn.java sample/module/SampleLoginModule.java sample/principal/SamplePrincipal.java

   コマンド全体を1行に入力してください。

6. SampleAzn.classおよびMyCallbackHandler.classを含むJARファイルSampleAzn.jarを作成します(注: これらのクラスのソース・ファイルはSampleAzn.java内にある)。

   jar -cvf SampleAzn.jar sample/SampleAzn.class sample/MyCallbackHandler.class

   コマンド全体を1行に入力してください。

7. SampleAction.classを含むSampleAction.jarという名前のJARファイルを作成します。

   jar -cvf SampleAction.jar sample/SampleAction.class

8. SampleLoginModule.classとSamplePrincipal.classを含むJARファイルを作成します。

   jar -cvf SampleLM.jar sample/module/SampleLoginModule.class sample/principal/SamplePrincipal.class

9. 次を指定して、SampleAznアプリケーションを実行します

   1. 適切な-classpath節(SampleAzn.jar、SampleAction.jar、およびSampleLM.jar JARファイル内のクラスを検索するため)。
   2. -Djava.security.manager。セキュリティ・マネージャのインストールを指定します。
   3. -Djava.security.policy==sampleazn.policy。使用するポリシー・ファイルとしてsampleazn.policyを指定します。
   4. -Djava.security.auth.login.config==sample_jaas.config。使用するログイン構成ファイルとしてsample_jaas.configを指定します。

   次に、WindowsおよびSolaris、LinuxおよびmacOSシステムで使用するすべてのコマンドを示します。クラス・パス項目の区切りとして、Solaris、LinuxおよびmacOSシステムではコロンを使用するのに対し、Windowsシステムではセミコロンを使用する点のみが異なります。

   次にWindowsシステムの全コマンドを示します。

   java -classpath SampleAzn.jar;SampleAction.jar;SampleLM.jar 
    -Djava.security.manager 
    -Djava.security.policy==sampleazn.policy 
    -Djava.security.auth.login.config==sample_jaas.config sample.SampleAzn
   

   次に、Solaris、LinuxおよびmacOSシステムのすべてのコマンドを示します。

   java -classpath SampleAzn.jar:SampleAction.jar:SampleLM.jar 
    -Djava.security.manager 
    -Djava.security.policy==sampleazn.policy 
    -Djava.security.auth.login.config==sample_jaas.config sample.SampleAzn
   

   コマンド全体を1行で入力してください。ここでは、読みやすくするために複数行に分けて表示してあります。システムに対しコマンドが長すぎる場合は、.batファイル(Windowsの場合)または.shファイル(Solaris、LinuxおよびmacOSの場合)に記述し、そのファイルを実行して、コマンドを実行する必要がある場合があります。

   ユーザー名とパスワードの入力が求められ(testUserとtestPasswordを使用)、ログイン構成ファイルに指定されたSampleLoginModuleにより、名前とパスワードがチェックされます。ログインが成功するとAuthentication succeeded!というメッセージが表示され、失敗するとAuthentication failed:の後に失敗の理由が続くメッセージが表示されます。

   認証が正常に完了すると、プログラム(SampleAction内)の他の部分がユーザーに代わって実行されます。このため、ユーザーは適切なアクセス権をあらかじめ保持している必要があります。ポリシー・ファイルsampleazn.policyにより、必要なアクセス権が付与されているため、java.homeおよびuser.homeシステム・プロパティの値、およびfoo.txtという名前のファイルが現在のディレクトリに存在するかどうかに関する文が表示されます。