forked from wso2/docs-is
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request wso2#1 from wso2/master
updated master branch
- Loading branch information
Showing
41 changed files
with
125 additions
and
135 deletions.
There are no files selected for viewing
Binary file not shown.
File renamed without changes
File renamed without changes
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ You can register external PEP Endpoints in the WSO2 Identity Server. The | |
Identity Server sends cache invalidation notifications (JSON, XML, | ||
EMAIL) to the pre-configured external PEP endpoints. Basic | ||
authentication will be used as the [authentication | ||
mechanism](https://docs.wso2.com/display/IS530/Configuring+Local+and+Outbound+Authentication+for+a+Service+Provider) | ||
mechanism](../../using-wso2-identity-server/configuring-local-and-outbound-authentication-for-a-service-provider) | ||
. | ||
|
||
This topic describes how you can enable the XACML engine to send | ||
|
@@ -13,25 +13,16 @@ a policy update or a change in user roles, permissions or | |
attributes. This also clears the internal cache when user roles, | ||
permissions or attributes are updated. | ||
|
||
1. If you are using EMAIL as the notification method, configure email | ||
transport details using the ` axis2.xml ` file. | ||
Follow the steps below to configure this: | ||
1. Navigate to the | ||
` <IS_HOME>/repository/conf/axis2/axis2.xml ` | ||
file. | ||
2. Configure the relevant attributes according to your email | ||
account information. The following is a sample configuration. | ||
|
||
``` xml | ||
<transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender"> | ||
<parameter name="mail.smtp.from">[email protected]</parameter> | ||
<parameter name="mail.smtp.user">wso2demomail</parameter> | ||
<parameter name="mail.smtp.password">mailpassword</parameter> | ||
<parameter name="mail.smtp.host">smtp.gmail.com</parameter> | ||
<parameter name="mail.smtp.port">587</parameter> | ||
<parameter name="mail.smtp.starttls.enable">true</parameter> | ||
<parameter name="mail.smtp.auth">true</parameter> | ||
</transportSender> | ||
1. If you are using EMAIL as the notification method, add and configure the following properties in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder. Update the address, username, and password parameters with the values of a valid email account. | ||
``` toml | ||
[output_adapter.email] | ||
from_address = | ||
username = | ||
password = | ||
hostname= | ||
port | ||
enable_start_tls | ||
enable_authentication | ||
``` | ||
|
||
2. Create an email template in | ||
|
@@ -41,57 +32,48 @@ permissions or attributes are updated. | |
sample template which contains the below code part. | ||
|
||
``` java | ||
Hi {username}, | ||
Hi {username}, | ||
|
||
XACML PDP policy store has been changed.. | ||
XACML PDP policy store has been changed.. | ||
|
||
Policy Id : {targetId} | ||
Action : {action} | ||
Policy : {target} | ||
Policy Id : {targetId} | ||
Action : {action} | ||
Policy : {target} | ||
|
||
Best Regards, | ||
http://xacmlinfo.org | ||
Best Regards, | ||
http://xacmlinfo.org | ||
``` | ||
|
||
3. Do the following to send notifications to external endpoints when | ||
there is a policy change. | ||
3. To send notifications to external endpoints when | ||
there is a policy change, add the following configuration to the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder. | ||
|
||
1. Navigate to the | ||
` <IS_HOME>/repository/conf/identity/entitlement.properties ` | ||
file. | ||
2. Make the following change. | ||
|
||
``` java | ||
PAP.Status.Data.Handler.2=org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension | ||
``` toml | ||
[identity.entitlement.policy_point.pap] | ||
status_data_handlers = ["org.wso2.carbon.identity.entitlement.SimplePAPStatusDataHandler"] | ||
``` | ||
|
||
Here the trailing number that is added after " | ||
` PAP.Status.Data.Handler ` " should be | ||
the minimum positive number you can add for a new " | ||
` PAP.Status.Data.Handler ` ". | ||
|
||
4. Additionally, add the following to the | ||
` entitlement.properties ` file and change | ||
accordingly. If you are sending notifications via email, use this | ||
and change the recipient email address. | ||
|
||
``` java | ||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,JSON | ||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,XML | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,EMAIL | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.2=ignoreServerVerification,true | ||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.3=targetUrl,http://targetUrlAddress;username;password | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.3=emailAddress,[email protected] | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.4=pdpNotificationAction,ENABLE;DISABLE;UPDATE;DELETE | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.5=papNotification,true | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.6=pdpNotification,true | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.9=roleName, admin | ||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,JSON | ||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,XML | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.1=notificationType,EMAIL | ||
|
||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.2=ignoreServerVerification,true | ||
|
||
#org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.3=targetUrl,http://targetUrlAddress;username;password | ||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.3=emailAddress,wso2demomail@gmail.com | ||
|
||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.4=pdpNotificationAction,ENABLE;DISABLE;UPDATE;DELETE | ||
|
||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.5=papNotification,true | ||
|
||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.6=pdpNotification,true | ||
|
||
org.wso2.carbon.identity.entitlement.EntitlementNotificationExtension.9=roleName, admin | ||
``` | ||
|
||
The following table lists out and describes the above attributes. | ||
|
@@ -118,41 +100,41 @@ permissions or attributes are updated. | |
notification can be configured. | ||
|
||
``` java | ||
module.name.1=email | ||
email.subscription.1=userOperation | ||
email.subscription.userOperation.template=/home/wso2dinali/SUPPORT/TRAVISPERKINSDEV-312/wso2is-5.3.0/repository/conf/email/entitlement-email-config.xml | ||
email.subscription.userOperation.salutation=Admin | ||
email.subscription.userOperation.subject=User operation change information | ||
email.subscription.userOperation.endpoint.1=privateMail | ||
email.subscription.userOperation.endpoint.privateMail.address=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.privateMail.salutation=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.privateMail.subject= The User Operation change has occured. | ||
# | ||
email.subscription.userOperation.endpoint.2=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.officeMail.address=wso2demomail@gmail.com | ||
# | ||
email.subscription.2=policyUpdate | ||
email.subscription.policyUpdate.template=<full path to the carbon- home>/repository/conf/email/entitlement-email-config.xml | ||
email.subscription.policyUpdate.salutation=Admin | ||
email.subscription.policyUpdate.subject= policy update information mail | ||
email.subscription.policyUpdate.endpoint.1=privateMail | ||
email.subscription.policyUpdate.endpoint.privateMail.address=wso2demomail@gmail.com | ||
email.subscription.policyUpdate.endpoint.privateMail.salutation=Admin | ||
email.subscription.policyUpdate.endpoint.privateMail.subject=policy update information to private [email protected] | ||
# | ||
#module.name.2=json | ||
#json.subscription.1=userOperation | ||
#json.subscription.userOperation.template=templatePath/jsonTemplate | ||
#json.subscription.userOperation.jsonId=3232 | ||
#json.subscription.userOperation.endpoint.1=pepEndpoint1 | ||
#json.subscription.userOperation.endpoint.pepEndpoint1.address=https://localhost:8080/testEndpoint1 | ||
#json.subscription.userOperation.endpoint.pepEndpoint1.username=testUsername | ||
#json.subscription.userOperation.endpoint.pepEndpoint2.password=testPW | ||
# | ||
#json.subscription.userOperation.endpoint.2=pepEndpoint2 | ||
#json.subscription.userOperation.endpoint.pepEndpoint2.address=https://localhost:8080/testEndpoint2 | ||
threadPool.size = 10 | ||
module.name.1=email | ||
email.subscription.1=userOperation | ||
email.subscription.userOperation.template=/home/wso2dinali/SUPPORT/TRAVISPERKINSDEV-312/wso2is-5.3.0/repository/conf/email/entitlement-email-config.xml | ||
email.subscription.userOperation.salutation=Admin | ||
email.subscription.userOperation.subject=User operation change information | ||
email.subscription.userOperation.endpoint.1=privateMail | ||
email.subscription.userOperation.endpoint.privateMail.address=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.privateMail.salutation=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.privateMail.subject= The User Operation change has occured. | ||
# | ||
email.subscription.userOperation.endpoint.2=wso2demomail@gmail.com | ||
email.subscription.userOperation.endpoint.officeMail.address=wso2demomail@gmail.com | ||
# | ||
email.subscription.2=policyUpdate | ||
email.subscription.policyUpdate.template=<full path to the carbon- home>/repository/conf/email/entitlement-email-config.xml | ||
email.subscription.policyUpdate.salutation=Admin | ||
email.subscription.policyUpdate.subject= policy update information mail | ||
email.subscription.policyUpdate.endpoint.1=privateMail | ||
email.subscription.policyUpdate.endpoint.privateMail.address=wso2demomail@gmail.com | ||
email.subscription.policyUpdate.endpoint.privateMail.salutation=Admin | ||
email.subscription.policyUpdate.endpoint.privateMail.subject=policy update information to private wso2demomail@gmail.com | ||
# | ||
#module.name.2=json | ||
#json.subscription.1=userOperation | ||
#json.subscription.userOperation.template=templatePath/jsonTemplate | ||
#json.subscription.userOperation.jsonId=3232 | ||
#json.subscription.userOperation.endpoint.1=pepEndpoint1 | ||
#json.subscription.userOperation.endpoint.pepEndpoint1.address=https://localhost:8080/testEndpoint1 | ||
#json.subscription.userOperation.endpoint.pepEndpoint1.username=testUsername | ||
#json.subscription.userOperation.endpoint.pepEndpoint2.password=testPW | ||
# | ||
#json.subscription.userOperation.endpoint.2=pepEndpoint2 | ||
#json.subscription.userOperation.endpoint.pepEndpoint2.address=https://localhost:8080/testEndpoint2 | ||
|
||
threadPool.size = 10 | ||
``` | ||
|
||
6. It is recommended to use https to communicate with external | ||
|
@@ -163,5 +145,5 @@ permissions or attributes are updated. | |
password for client-truststore.jks is "wso2carbon". | ||
|
||
``` java | ||
keytool -import -alias wso2 -file <path_to_your_certificate_file>/yourCertificate.crt -keystore <CARBON_SERVER>/repository/resources/security/client-truststore.jks | ||
keytool -import -alias wso2 -file <path_to_your_certificate_file>/yourCertificate.crt -keystore <CARBON_SERVER>/repository/resources/security/client-truststore.jks | ||
``` |
Oops, something went wrong.