2 OPSSセキュリティ・ストアのWLSTコマンド

この章では、OPSSセキュリティ・ストア・コマンドについて説明します。

表2-1に示されているWLSTセキュリティ・コマンドを使用して、ドメイン・ポリシーまたは資格証明ストアの操作、ソース・リポジトリからターゲット・リポジトリへのポリシーおよび資格証明の移行、および(資格証明の)暗号化キーのエクスポートとインポートを行います。

表2-1 WLSTセキュリティ・コマンド

使用するコマンド...	目的...	使用するWLST...
addBootStrapCredential	資格証明をブート・ストラップ資格証明ストアに追加します	オフライン
addResourceToEntitlement	資格にリソースを追加します。	オンライン
createAppRole	新しいアプリケーション・ロールを作成します。	オンライン
createCred	新しい資格を作成します。	オンライン
createEntitlement	資格を作成します。	オンライン
createResource	リソースを作成します。	オンライン
createResourceType	新しいリソース・タイプを作成します。	オンライン
deleteAppPolicies	アプリケーション内のすべてのポリシーを削除します。	オンライン
deleteAppRole	アプリケーション・ロールを削除します。	オンライン
deleteCred	資格証明を削除します。	オンライン
deleteEntitlement	資格を削除します。	オンライン
deleteResource	リソースを削除します。	オンライン
deleteResourceType	既存のリソース・タイプを削除します。	オンライン
exportEncryptionKey	ドメイン暗号化キーをファイルewallet.p12にエクスポートします。	オフライン
getEntitlement	資格を一覧表示します。	オンライン
getResourceType	既存のリソース・タイプをフェッチします。	オンライン
grantAppRole	ロールにプリンシパルを追加します。	オンライン
grantEntitlement	資格を作成します。	オンライン
grantPermission	新しい特権を作成します。	オンライン
importEncryptionKey	ファイルewallet.p12内の暗号化キーをドメインにインポートします。	オフライン
listAppRoles	アプリケーション内のすべてのロールを表示します。	オンライン
listAppRolesMembers	アプリケーション・ロール内のすべてのメンバーを表示します。	オンライン
listAppStripes	ポリシー・ストア内のアプリケーション・ストライプを一覧表示します。	オンライン
listCodeSourcePermissions	グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示します。	オンライン
listEntitlement	資格を一覧表示します。	オンライン
listEntitlements	アプリケーション・ストライプ内の資格を一覧表示します。	オンライン
listPermissions	プリンシパルに付与されたすべての特権を表示します。	オンライン
listResourceActions	リソースのアクションを一覧表示します。	オンライン
listResources	アプリケーション・ストライプ内のリソースを一覧表示します。	オンライン
listResourceTypes	アプリケーション・ストライプ内のリソース・タイプを一覧表示します。	オンライン
listSecurityStoreInfo	OPSSセキュリティ・ストアのタイプと場所、およびアクセスを許可されているユーザーを一覧表示します。	オフライン
migrateSecurityStore	ポリシーまたは資格をソース・リポジトリから対象リポジトリに移動します。	オフライン
modifyBootStrapCredential	ブート・ストラップ資格ストアを更新します。	オフライン
reassociateSecurityStore	ポリシーおよび資格をLDAPリポジトリに再び関連付けます。	オンライン
restoreEncryptionKey	ドメイン暗号化キーを、直近のインポートの前の状態にリストアします。	オフライン
revokeAppRole	ロールからプリンシパルを削除します。	オンライン
revokeEntitlement	資格を削除します。	オンライン
revokePermission	権限を削除します。	オンライン
revokeResourceFromEntitlement	資格からリソースを削除します	オンライン
rollOverEncryptionKey	現在のドメイン暗号化キーを新しい暗号化キーに置換します。	オフライン
updateCred	資格の属性の値を変更します。	オンライン
updateTrustServiceConfig	トラスト・サービスの構成を更新します。	オンライン

ノート:

構文の説明では、オプションの引数は角カッコで囲まれています。それ以外のすべての引数は必須です。

• addBootStrapCredential
  
• addResourceToEntitlement
  
• createAppRole
  
• createCred
  
• createEntitlement
  
• createResource
  
• createResourceType
  
• deleteAppPolicies
  
• deleteAppRole
  
• deleteCred
  
• deleteEntitlement
  
• deleteResource
  
• deleteResourceType
  
• exportEncryptionKey
  
• getEntitlement
  
• getResourceType
  
• grantAppRole
  
• grantEntitlement
  
• grantPermission
  
• importEncryptionKey
  
• listAppRoles
  
• listAppRolesMembers
  
• listAppStripes
  
• listCodeSourcePermissions
  
• listEntitlement
  
• listEntitlements
  
• listPermissions
  
• listResourceActions
  
• listResources
  
• listResourceTypes
  
• listSecurityStoreInfo
  
• migrateSecurityStore
  
• modifyBootStrapCredential
  
• reassociateSecurityStore
  
• restoreEncryptionKey
  
• revokeAppRole
  
• revokeEntitlement
  
• revokePermission
  
• revokeResourceFromEntitlement
  
• rollOverEncryptionKey
  
• updateCred
  
• updateTrustServiceConfig
  

addBootStrapCredential

資格証明をブート・ストラップ資格証明ストアに追加するオフライン・コマンド。

説明

指定されたマップ、キー、ユーザー名およびユーザー・パスワードを持つパスワード資格証明を、JPS構成ファイルのデフォルトのJPSコンテキストで構成されたブートストラップ資格証明に追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

addBootStrapCredential(jpsConfigFile, map, key, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。
map	追加する資格証明のマップを指定します。
key	追加する資格証明のキーを指定します。
username	追加する資格証明のユーザーの名前を指定します。
password	追加する資格証明のユーザーのパスワードを指定します。

例

次の例は、ブートストラップ資格証明ストアに資格証明を追加します。

wls:/mydomain/serverConfig> addBootStrapCredential(jpsConfigFile='./jps-config.xml', map='myMapName', key='myKeyName', username='myUser', password='password')

addResourceToEntitlement

指定されたアクションを持つリソースを資格に追加するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格に、指定されたアクションを持つリソースを追加します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

addResourceToEntitlement(appStripe="appStripeName", name="entName", resourceName="resName",actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	追加するリソースの名前を指定します。
resourceType	追加するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
actions	追加されるリソースのアクションのカンマ区切りのリストを指定します。

例

次の例は、アプリケーション・ストライプmyApplicationの権限myEntitlementにリソースmyResourceを追加します。

wls:/mydomain/serverConfig> addResourceToEntitlement(appStripe="myApplication", 
name="myEntitlement", resourceName="myResource", resourceType="myResType", 
actions="view,edit")

createAppRole

新しいアプリケーション・ロールを作成するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアに作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数	定義
appSripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleを持つ新しいアプリケーション・ロールを作成します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

createCred

ドメイン資格ストアに新しい資格を作成するオンライン・コマンドを示します。

説明

指定したマップ名、キー名、タイプ、ユーザー名およびパスワード、URLおよびポート番号のドメイン資格ストアに新しい資格を作成します。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

createCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格ユーザー名を指定します。
password	資格のパスワードを指定します。
desc	資格を説明する文字列を指定します。

例

次の例は、指定したデータで新しいパスワード資格証明を作成します。

wls:/mydomain/serverConfig> createCred(map="myMap, key="myKey", user="myUsr", 
password="password", desc="updated usr name and passw to connect to app xyz")

createEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプに、1つのリソースとアクションのリストを持つ新しい資格を作成します。既存の資格にリソースを追加するにはaddResourceToEntitlementを使用し、既存の資格からリソースを削除するにはrevokeResourceFromEntitlementを使用します。

構文

createEntitlement(appStripe="appStripeName", name="entitlementName", resourceName="resName", actions="actionList" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
name	作成する資格の名前を指定します。
resourceName	作成する資格の1つのリソース・メンバーの名前を指定します。
actions	リソースresourceNameのアクションのカンマ区切りのリストを指定します。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成する資格の説明を指定します。オプション。

例

次の例は、ストライプmyApplicationにリソースmyResourceのみの権限myEntitlementを作成します。

wls:/mydomain/serverConfig> createEntitlement(appStripe="myApplication", name="myEntitlement", resourceName="myResource", actions="read,write")

createResource

新しいリソースを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたタイプのリソースを作成します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

createResource(appStripe="appStripeName", name="resName", type="resTypeName" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	リソースの作成対象のアプリケーション・ストライプを指定します。
name	作成するリソースの名前を指定します。
type	作成するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成するリソースの説明を指定します。オプション。

例

次の例は、ストライプmyApplicationにリソースmyResourceを作成します。

wls:/mydomain/serverConfig> createResource(appStripe="myApplication", name="myResource", type="myResType", displayName="myNewResource")

createResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに新しいリソース・タイプを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに、指定された名前、表示名、説明およびアクションを持つ新しいリソース・タイプ要素を作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createResourceType(appStripe, resourceTypeName, displayName, description [, provider] [, matcher], actions [, delimeter])

引数	定義
appStripe	リソース・タイプの挿入対象のアプリケーション・ストライプを指定します。
resourceTypeName	挿入するリソース・タイプの名前を指定します。
displayName	UIガジェットで使用されるリソース・タイプの名前を指定します。
description	リソース・タイプの簡単な説明を指定します。
provider	リソース・タイプのプロバイダを指定します。
matchere	リソース・タイプのクラスを指定します。指定しない場合、この値はデフォルトのoracle.security.jps.ResourcePermissionに設定されます。
actions	このリソース・タイプのインスタンスで許可されるアクションを指定します。
delimeter	アクションのリストでデリミタとして使用する文字を指定します。指定しない場合、この値はデフォルトのカンマ(,)に設定されます。

例

次の例は、セミコロンで区切って指定したアクションBWPrintおよびアクションColorPrintを設定したリソース・タイプをストライプmyApplicationに作成します。

wls:/mydomain/serverConfig> createResourceType(appStripe="myApplication", 
resourceTypeName="resTypeName", displayName="displName", description="A resource
type", provider="Printer", matcher="com.printer.Printer",
actions="BWPrint;ColorPrint" [, delimeter=";"])

deleteAppPolicies

指定したアプリケーション・ストライプのすべてのポリシーを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプのすべてのポリシーを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteAppPolicies(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

例

次の例は、アプリケーションmyAppのすべてのポリシーを削除します。

wls:/mydomain/serverConfig> deleteAppPolicies(appStripe="myApp")

deleteAppRole

アプリケーション・ロールを削除するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールを削除します。

wls:/mydomain/serverConfig> deleteAppRole(appStripe="myApp", appRoleName="myRole")

deleteCred

ドメイン資格ストア内の資格を削除するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格をドメイン資格ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteCred(map,key)

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。

例

次の例は、マップ名myMapおよびキー名myKeyを持つ資格証明を削除します。

wls:/mydomain/serverConfig> deleteCred(map="myApp",key="myKey")

deleteEntitlement

資格を削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格を削除します。アプリケーション・ストライプ内の指定された資格へのすべての参照を削除することで、カスケード削除を実行します。

構文

deleteEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
name	削除する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementを削除します。

wls:/mydomain/serverConfig> deleteEntitlement(appStripe="myApplication", name="myEntitlement")

deleteResource

リソースを削除するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格からリソースおよびそのすべての参照を削除します。このコマンドは、カスケード削除を実行します。資格が1つのリソースのみを参照している場合は、その資格を削除し、それ以外の場合は、渡されたタイプのリソース・アクションを資格から削除します。

構文

deleteResource(appStripe="appStripeName", name="resName", type="resTypeName")

引数	定義
appStripe	リソースの削除対象のアプリケーション・ストライプを指定します。
name	削除するリソースの名前を指定します。
type	削除するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の例は、ストライプmyApplicationのリソースmyResourceを削除します。

wls:/mydomain/serverConfig> deleteResource(appStripe="myApplication", name="myResource", type="myResType")

deleteResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプの削除元となるアプリケーション・ストライプを指定します。
resourceTypeName	削除するリソース・タイプの名前を指定します。

例

次の例は、ストライプmyApplicationからリソース・タイプmyResTypeを削除します。

wls:/mydomain/serverConfig> deleteResourceType(appStripe="myApplication", resourceTypeName="myResType")

exportEncryptionKey

ドメインのブートストラップ・ウォレットからファイルewallet.p12に暗号化キーを抽出するオフライン・コマンド。

説明

ドメインの資格証明暗号化キーをファイルewallet.p12に書き込みます。コマンドimportEncryptionKeyを使用してそのファイルからデータをインポートするには、このコマンドで渡されるパスワードを使用する必要があります。

exportEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

構文

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。
keyFilePath	ファイルewallet.p12の作成先となるディレクトリを指定します。このファイルのコンテンツは暗号化されており、keyFilePasswordに渡される値によって保護されていることに注意してください。
keyFilePassword	ファイルewallet.p12を保護するためのパスワードを指定します。このファイルをインポートする際は、これと同じパスワードを使用する必要があることに注意してください。

例

次の例は、ディレクトリmyDirにファイルewallet.p12を書き込みます。

exportEncryptionKey(jpsConfigFile="pathName", keyFilePath="myDir" ,keyFilePassword="password")

getEntitlement

資格を取得するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格の名前、表示名およびすべてのリソース(とそれらの資格)を戻します。

構文

getEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	アクセスする資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementの情報を返します。

wls:/mydomain/serverConfig> getEntitlement(appStripe="myApplication", name="myEntitlement")

getResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプをフェッチするオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリの関連パラメータを取得します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプのフェッチ元となるアプリケーション・ストライプを指定します。
resourceTypeName	フェッチするリソース・タイプの名前を指定します。

例

次の例は、ストライプmyApplicationからリソース・タイプmyResTypeをフェッチします。

wls:/mydomain/serverConfig> getResourceType(appStripe="myApplication", resourceTypeName="myResType")

grantAppRole

ロールにプリンシパルを追加するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールにプリンシパル(クラスまたは名前)を追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

grantAppRole(appStripe, appRoleName,principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。LDAPサーバーからユーザーまたはグループのCNまたはDN属性値を設定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールにプリンシパルを追加します。

• アプリケーション・ロール設定CNの付与

  wls:/mydomain/serverConfig> grantAppRole(appStripe="myApp",
   appRoleName="myRole",principalClass="com.example.xyzPrincipal",
  principalName="Admin")

• アプリケーション・ロール設定DNの付与

  wls:/mydomain/serverConfig> grantAppRole(appStripe="myApp",
   appRoleName="myRole",principalClass="com.example.xyzPrincipal",
  principalName="cn=Admin,ou=IT,ou=Groups,dc=vm,dc=oracle,dc=com")

詳細は、ドキュメントID 2858916.1を参照してください。

grantEntitlement

名前の付けられたプリンシパルに資格を付与するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の指定されたプリンシパルに資格を付与します。

構文

grantEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	プリンシパルが存在するアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が付与されるプリンシパルの名前を指定します。
permSetName	付与する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの資格myEntitlementをプリンシパルmyPrincipalNameに付与します。

wls:/mydomain/serverConfig> grantEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

grantPermission

新しい特権を作成するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLに対して新しい特権を作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

grantPermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	特権のあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、特権対象の名前を指定します。一部の特権には、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部の特権には、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の例は、指定したデータでアプリケーションの新しい特権(アプリケーション・ストライプmyAppのアプリケーション)を作成します。

wls:/mydomain/serverConfig> grantPermission(appStripe="myApp",  
principalClass="my.custom.Principal",  principalName="manager",
permClass="java.security.AllPermission")

次の例は、指定したデータでシステムの新しい特権を作成します。

wls:/mydomain/serverConfig> grantPermission(principalClass="my.custom.Principal", principalName="manager",   
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permTarget="/tmp/fileName.ext", permActions="read,write")

importEncryptionKey

指定されたewallet.p12ファイルからドメインにキーをインポートするオフライン・コマンド。

説明

次の呼出しは、ファイルewallet.p12からドメインに暗号化キーをインポートします。渡されるパスワードは、コマンドexportEncryptionKeyを使用してファイルを作成する際に使用されたものと同じである必要があります。

構文

importEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。
keyFilePath	ewallet.p12の書込み先となるディレクトリを指定します。
keyFilePassword	ファイルewallet.p12の生成時に使用されたパスワードを指定します。

例

importEncryptionKey(jpsConfigFile="pathName", keyFilePath="dirloc" ,keyFilePassword="password")

listAppRoles

アプリケーション内のすべてのロールを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプ内のすべてのロールを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoles(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。

例

次の例は、アプリケーション・ストライプmyAppのすべてのロールを返します。

wls:/mydomain/serverConfig> listAppRoles(appStripe="myApp")

listAppRolesMembers

ロール内のすべてのメンバーを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよびロール名のロール内のすべてのメンバーを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoleMembers(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロール内のすべてのメンバーを返します。

wls:/mydomain/serverConfig> listAppRoleMembers(appStripe="myApp", appRoleName="myRole")

listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示するオンラインまたはオフライン・コマンド。

説明

このスクリプトは、オフライン・モードまたはオンライン・モードで実行できます。オフライン・モードで実行する場合は、構成ファイルを渡す必要があります。渡された構成ファイルのデフォルト・コンテキストで構成によって参照されるポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。デフォルトの構成には、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。オンライン・モードで実行する場合は、構成ファイルを渡さないでください。接続しているドメインのポリシー・ストア内のストライプが一覧表示されます。いずれのモードでも、正規表現が渡されると、その正規表現に一致する名前を持つアプリケーション・ストライプが一覧表示されます。それ以外の場合は、すべてのアプリケーション・ストライプが一覧表示されます。

構文

listAppStripes([configFile="configFileName"] [, regularExpression="aRegExp"])

引数	定義
configFile	OPSS構成ファイルへのパスを指定します。オプション。指定した場合、スクリプトはオフラインで実行されます。指定された構成ファイルのデフォルト・コンテキストに、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。指定しない場合、スクリプトはオンラインで実行され、ポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。
regularExpression	正規表現を指定します。この正規表現に一致するストライプ名が戻されます。オプション。指定しない場合、すべての名前が一致します。サブストリングに一致させるには、文字*を使用します。

例

次の(オンライン)呼出しは、ポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes

次の(オフライン)呼出しは、指定された構成ファイルのデフォルト・コンテキストで参照されるポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(configFile=" 
/home/myFile/jps-config.xml")

次の(オンライン)呼出しは、接頭辞Appを含むアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(regularExpression="App*")

listCodeSourcePermissions

グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示するオンライン・コマンド。

説明

このコマンドによって、グローバル・ポリシーのコードベース権限の一覧表示が可能になります。

構文

listCodeSourcePermissions([codeBase="codeUrl"])

引数	定義
codeBaseURL	権限受領者のコードベースURL名を指定します。

例

次の例は、すべてのグローバル・ポリシーのコード・ソースに割り当てられたリスト権限を戻します。

wls:/mydomain/serverConfig> listCodeSourcePermissions(codeBaseURL="file:/tmp/lib/myJars.jar")

listEntitlement

指定されたアプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

プリンシパル名およびクラスを指定した場合、指定されたプリンシパルに一致する資格が一覧表示されます。それ以外の場合は、すべての資格が一覧表示されます。

構文

listEntitlement(appStripe="appStripeName" [, principalName="principalName", principalClass="principalClass"])

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalName	一致させるプリンシパルの名前を指定します。オプション。
principalClass	一致させるプリンシパルのクラスを指定します。オプション。

例

次の例は、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

listEntitlements

アプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内のすべての資格を一覧表示します。リソース名およびリソース・タイプを指定した場合、指定されたリソース名に一致する、指定されたタイプのリソースを持つ資格が一覧表示されます。それ以外の場合は、アプリケーション・ストライプ内のすべての資格が一覧表示されます。

構文

listEntitlements(appStripe="appStripeName" [,resourceTypeName="resTypeName", resourceName="resName"])

引数	定義
appStripe	資格の一覧表示対象のアプリケーション・ストライプを指定します。
resourceTypeName	一覧表示するリソースのタイプの名前を指定します。オプション。
resourceName	一致させるリソースの名前を指定します。オプション。

例

次の例は、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication")

次の例は、リソース・タイプmyResType、およびリソース名がmyResNameに一致するリソースを含む、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication", resourceTypeName="myResType", resourceName="myResName") 

listPermissions

指定したプリンシパルに付与したすべての特権を表示するオンライン・コマンドを示します。

説明

指定したプリンシパルに付与されたすべての特権を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listPermissions([appStripe,] principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。

例

次の例は、アプリケーションmyAppのポリシーによってプリンシパルに付与したすべての特権を表示します。

wls:/mydomain/serverConfig> listPermissions(appStripe="myApp", principalClass="my.custom.Principal",principalName="manager")
                

次の例は、システム・ポリシーによってプリンシパルに付与したすべての特権を表示します。

wls:/mydomain/serverConfig> listPermissions(principalClass="my.custom.Principal", principalName="manager")

listResourceActions

資格のリソースとアクションを一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格のリソースとアクションを一覧表示します。

構文

listResourceActions(appStripe="appStripeName", permSetName="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
permSetName	リソースとアクションを一覧表示する資格の名前を指定します。

例

次の例は、ストライプmyApplication内の資格myEntitlementのリソースとアクションを一覧表示します。

wls:/mydomain/serverConfig> listResourceActions(appStripe="myApplication", permSetName="myEntitlement")

listResources

指定されたアプリケーション・ストライプ内のリソースを一覧表示するオンライン・コマンド。

説明

リソース・タイプを指定した場合、指定されたリソース・タイプのすべてのリソースが一覧表示されます。それ以外の場合は、すべてのタイプのすべてのリソースが一覧表示されます。

構文

listResources(appStripe="appStripeName" [,type="resTypeName"])

引数	定義
appStripe	リソースの一覧表示対象のアプリケーション・ストライプを指定します。
type	一覧表示するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の例は、ストライプmyApplication内のタイプmyResTypeのすべてのリソースを一覧表示します。

wls:/mydomain/serverConfig> listResources(appStripe="myApplication", type="myResType")

listResourceTypes

リソース・タイプを一覧表示するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のすべてのリソース・タイプを一覧表示します。

構文

listResourceTypes(appStripe="appStripeName")

引数	定義
appStripe	リソース・タイプが存在するアプリケーション・ストライプを指定します。

例

次の例は、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> listResourceTypes(appStripe="myApplication")

listSecurityStoreInfo

ドメイン・セキュリティ・ストアのタイプ、場所および管理ユーザーを一覧表示するオフライン・コマンド。

説明

スクリプトはオフライン・モードで実行され、OPSSセキュリティ・ストアのタイプ(ファイル、OIDまたはDB)、場所、およびアクセスを許可されているユーザー(通常はセキュリティ管理者)を出力します。

構文

listSecurityStoreInfo(domainConfig="configFilePath")

引数	定義
domainConfig	OPSS構成ファイルjps-config.xmlへの完全絶対パスを指定します。渡されるディレクトリには、ファイルjps-config-jse.xmlも含まれている必要があります。

例

次の例は、OPSSポリシー・ストアのタイプ、場所および管理ユーザーを戻します。

wls:/mydomain/serverConfig> listSecurityStoreInfo(domainConfig="/home/myConfigPathDirectory/config/fmwconfig")

次の各行は、このコマンドによって生成されたサンプル出力を示しています。

For jps-config.xml
Store Type: DB_ORACLE
Location/Endpoint: jdbc:oracle:thin:@adc2120515.us.myComp.com:1555/OWSM.US.COM
User: DEV_OPSS
Datasource: jdbc/OpssDataSource
For jps-config-jse.xml
Store Type: DB_ORACLE
Location/Endpoint: jdbc:oracle:thin:@adc2120515.us.myComp.com:1521/OWSM.US.COM
User: DEV_OPSS

migrateSecurityStore

ID、アプリケーション特定ポリシー、システム・ポリシー、特定資格フォルダまたはすべての資格を移動するオフライン・コマンドを示します。

説明

セキュリティ・アーティファクトをソース・リポジトリからターゲット・リポジトリに移行します。『Oracle Platform Security Servicesによるアプリケーションの保護』のスクリプトmigrateSecurityStoreを使用した移行に関する項を参照してください。

modifyBootStrapCredential

ブート・ストラップ資格ストアを更新するオフライン・コマンドを示します。

説明

指定したユーザー名およびパスワードでブート・ストラップ資格を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

一般的に、次のシナリオの場合に使用されます: ドメイン・ポリシーおよび資格証明ストアはLDAPベースで、(LDAPサーバーに格納された)LDAPストアにアクセスする資格証明が変更されたとします。その後、このコマンドを使用して、ブート・ストラップ資格ストアにこれらの変更を設定できます。

構文

modifyBootStrapCredential(jpsConfigFile, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。
username	LDAPストア内のユーザーの識別名を指定します。
password	ユーザーのパスワードを指定します。

例

LDAPストアで識別名cn=orcladminを持つユーザーのパスワードがpasswordに変更されており、構成ファイルjps-config.xmlが現在のディレクトリに存在する場合、次の例では、ブートストラップ資格証明ストアのパスワードをpasswordに変更します:

wls:/mydomain/serverConfig> modifyBootStrapCredential(jpsConfigFile='./jps-config.xml', username='cn=orcladmin', password='password')

監査サービスに対する任意の出力を無視できます。

reassociateSecurityStore

ポリシーおよび資格ストアをLDAPリポジトリに移動するオンライン・コマンドを示します。

説明

スクリプトreassociateSecurityStoreは、OPSSセキュリティ・ストアをソースからLDAPベースまたはDBベースのターゲット・ストアに移行して、jps-config.xmlファイルおよびjps-config-jse.xmlファイル内のサービスをターゲット・リポジトリにリセットします。また、別のドメイン内のOPSSセキュリティ・ストアを指定して共有することもできます(後述のオプション引数joinを参照)。OPSSのバイナリとターゲットのポリシー・ストアには、バージョンの互換性が必要です。

詳細および例は、『Oracle Platform Security Servicesによるアプリケーションの保護』を参照してください。

restoreEncryptionKey

ドメイン資格証明暗号化キーをリストアするオフライン・コマンド。

説明

ドメイン・ブートストラップ・キーの状態を、importEncryptionKeyの実行前の状態にリストアします。

構文

restoreEncryptionKey(jpsConfigFile)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。

例

restoreEncryptionKey(jpsConfigFile="pathName")

revokeAppRole

ロールからプリンシパルを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールからプリンシパル(クラスまたは名前)を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

revokeAppRole(appStripe, appRoleName, principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。LDAPサーバーからユーザーまたはグループのCNまたはDN属性値を設定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールからプリンシパルを削除します。

• アプリケーション・ロール設定CNの取消し

  wls:/mydomain/serverConfig> revokeAppRole(appStripe="myApp",
   appRoleName="myRole",principalClass="com.example.xyzPrincipal",
  principalName="Admin")

• アプリケーション・ロール設定DNの取消し

  wls:/mydomain/serverConfig> revokeAppRole(appStripe="myApp",
   appRoleName="myRole",principalClass="com.example.xyzPrincipal",
  principalName="cn=Admin,ou=IT,ou=Groups,dc=vm,dc=oracle,dc=com")

詳細は、ドキュメントID 2858916.1を参照してください。

revokeEntitlement

資格を削除するオンライン・コマンド。

説明

資格を削除し、指定されたアプリケーション・ストライプ内のプリンシパルからその資格を取り消します。

構文

revokeEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が取り消されるプリンシパルの名前を指定します。
permSetName	削除する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementを削除します。

wls:/mydomain/serverConfig> revokeEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

revokePermission

特権を削除するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLの特権を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

revokePermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	特権のあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、特権対象の名前を指定します。一部の特権には、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部の特権には、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の例は、指定したデータのアプリケーション特権(アプリケーション・ストライプmyAppのアプリケーション)を削除します。

wls:/mydomain/serverConfig> revokePermission(appStripe="myApp",  
principalClass="my.custom.Principal", principalName="manager", 
permClass="java.security.AllPermission")

以下の例は、システムの指定したデータの特権を削除します。

wls:/mydomain/serverConfig> revokePermission(principalClass="my.custom.Principal", principalName="manager",  
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permActions="read,write")

revokeResourceFromEntitlement

資格からリソースを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格からリソースを削除します。

構文

revokeResourceFromEntitlement(appStripe="appStripeName", name="entName", resourceName="resName", resourceType="resTypeName", actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	削除するリソースの名前を指定します。
resourceType	削除するリソースのタイプを指定します。
actions	削除するアクションのカンマ区切りのリストを指定します。

例

次の例は、ストライプmyApplication内の資格myEntitlementからリソースmyResourceを削除します。

wls:/mydomain/serverConfig> revokeResourceFromEntitlement(appStripe="myApplication", name="myEntitlement", 
resourceName="myResource", resourceType="myResType", actions="view,edit")

rollOverEncryptionKey

ドメイン暗号化キーを変更するオフライン・コマンド。

説明

このオフライン・スクリプトは、現在のドメインOPSS暗号化キーを新しい暗号化キーに置換します。現在のキーは削除されずにアーカイブされ、そのキーを使用して暗号化したデータの復号化に使用されます。

次の重要な点に注意してください。

• このコマンドは、ドメイン内の管理サーバーから実行する必要があります。実行後、サーバーを再起動する必要はありません。

• ドメインがセキュリティ・ストアにアクセスしている唯一のドメインである場合は、他に必要な操作はありません。

• ただし、2つ以上のドメインがセキュリティ・ストアを共有している場合は、exportEncryptionKeyおよびimportEncryptionKeyスクリプトを使用して、スクリプトが実行されたドメインから新しく生成されたキーをエクスポートし、セキュリティ・ストアを共有しているその他のドメインそれぞれにインポートする必要があります。

構文

rollOVerEncryptionKey(jpsConfigFile="pathName")

引数	定義
jpsConfigFile	jps-config.xmlファイルの場所を指定します。このスクリプトを実行する場所への相対パスまたはフルパスを指定します。 ノート: jpsConfigFile引数にはjps-config.xmlファイルまたはjps-config-jse.xmlファイルを指定できます。

例

次の例は、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> rollOverEncryptionKey(jpsConfigFile="myConfig")

updateCred

資格のタイプ、ユーザー名およびパスワードを変更するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格ストア内の資格のタイプ、ユーザー名、パスワード、URLおよびポート番号を変更します。このコマンドは、パスワード・タイプのみの資格にカプセル化されたデータを更新できます。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

updateCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格ユーザー名を指定します。
password	資格のパスワードを指定します。
desc	資格を説明する文字列を指定します。

例

次の例は、指定したデータでパスワード資格証明を更新します。

wls:/mydomain/serverConfig> updateCred(map="myMap", key="myKey", user="myUsr", 
password="password", desc="updated passw cred to connect to app xyz")

updateTrustServiceConfig

ドメイン・トラスト・サービスの構成を、プロパティ・ファイルで渡された値で更新するオフライン・コマンド。

説明

ドメイン・トラスト・サービスの構成を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateTrustServiceConfig([providerName="<the provider name>",] 
                          propsFile="<path of properties file>")

引数	定義
providerName	(オプション)トラスト・サービス・プロバイダの名前を指定します。指定を省略すると、デフォルトでtrust.provider.embeddedが設定されます。
propsFile	プロパティ値が設定されているファイルへのパスを指定します。

プロパティ・ファイルの例を示します。

trust.keystoreType=KSS
trust.keyStoreName=kss://<stripeName>/<keystoreName>
trust.trustStoreName=kss://<stripeName>/<truststoreName>
trust.aliasName=<aliasName>
trust.issuerName=<aliasName>

指定されるプロパティのリストは、プロパティtrust.keystoreTypeの値によって異なる点に注意してください。可能なタイプはKSSまたはJKSです。プロパティが空の文字列に設定されている場合、そのプロパティはトラスト・サービス構成から削除されます。使用可能なプロパティのリストは、『Oracle Platform Security Servicesによるアプリケーションの保護』のトラスト・サービスのプロパティに関する項を参照してください。

例

次の例は、ファイルmyPropsで指定された値でトラスト・ストア・サービスを更新します。

wls:/mydomain/serverConfig> updateTrustServiceConfig(providerName="myProvider", propsFile="myProps")