WebLogic Server Scripting Tool (WLST) provides powerful command-line capability for system administrators and developers to configure WebLogic server environments. However, its usage and adoption does not reach its full potential, seen at many working places, due to various reasons. This article gives a detailed example of using WLST to configure some of the latest security provisions (SAML 2.0) of WebLogic server, and provides insights on how to overcome the possible hurdles which prevent one from using the tool.

Why WLST and What's Stopping You?
Now it's not difficult to do a little research yourself and find out WLST is useful for configuring WebLogic server and Jython/Python itself is a popular scripting language, so why WLST is not used, or at least not consistently used, in many WebLogic projects, considering it has existed for quite some time.

After all, the benefits of using a scripting language in the task of setting up a server seem very appealing, in comparison to doing it using GUI console:

• Do it once, and use the same script for multiple servers or multiple project environments, e.g. development, integration testing, staging, production;
• Script runs faster than manual configuration;
• Script is less error-prone;
• Script can be easily source controlled;
• Script is more apt to be consolidated into enterprise standard.

So what's stopping you?

The first reason is Jython. To do WLST, you need to create Jython scripts. However, that's a gray area between system administration and programming. It involves knowing physical environment, WebLogic server structure and internal objects (MBeans), application needs and structures, and most importantly putting everything together using Jython script. Neither administrators nor developers are very comfortable with handling this task alone.

Another reason is why scripting if there's an easy to use GUI console. Even so, when you navigate the object tree within WLST, some objects or operations are not easily found. While within WebLogic GUI console, what you're looking for is more handily available.

Furthermore, although there's some information on using the tool, including a detailed command list within WebLogic document, you still need to do your own research to figure out the details when scripting specific components you want.

The following sections address those concerns, as well as walking through an example on setting up SAML 2.0 related security components.

Learning Jython (or Not)
Jython is the Java implementation of the Python scripting language. Scripting language usually provides a faster to development programming environment and has a task oriented nature.

But do you really need to spend the next several months learning a new language (if you don't already know) before using WLST? It's actually not necessary if you're already programming savvy (Java, Shell, etc.). As you will see from the example, the essential functions for configuration are easy to understand, and with the help of WebLogic documentation, the WLST commands can be easily practiced with WLST interactive mode to get familiar with. You may also do some recording at the same time so the commands can later be put into a script file. With that experience, it should help you to learn details of the Jython language more easily should the need arise.

Console or Scripting or Both
WebLogic GUI console is a convenient tool for making configurations. However, when it comes time to move configuration from one environment to another, it becomes cumbersome. Writing scripts, on the other hand, can help you easily add a specific component across various enterprise environments without much hassle.

But you're not familiar with navigating through the object tree within WLST yet. Sometimes you feel it's difficult to find an object or operation.

The trick here is to use console as guidance when writing scripts. The navigation sequence in GUI console doesn't match totally to that of the command line, but close enough in many cases. You can also use ls() and cmo() (WLST commands) constantly in combination with hints got from GUI console to guess what path you should take to write the next piece of script.

A Real Example
If you can read a little about WebLogic MBean structure and SAML 2.0 technology, e.g. through the references listed in the end, it may help you to understand this section better. However, it's not necessary if you just want to have more understanding of WLST and get confident to start your own script. The example here assumes WebLogic 10.3, but the same idea should apply to other versions as well. Also, it only covers SAML token consumer, and not the identity provider.

Let's start by defining some common variables:

user = ‘administrator'

pwd = 'password'

serverPath = 't3://localhost:7001'

domainName = ‘TestDomain'

idpMetaFile = '/idp/security/metadata.xml'

Note: the metadata.xml is provided by SAML identity provider, which could be another WebLogic server, or a third-party provider.

Next, connect to the server:

connect(user, pwd, serverPath)

Now, create the essential SAML identity asserter and authenticator:

edit()

rlmPath = ‘/SecurityConfiguration/' + domainName + ‘/Realms/myrealm'

cd(rlmPath)

startEdit()

saml2iaName = "SAML2IdentityAsserter"

samlauthName = "SAMLAuthenticator"

cmo.createAuthenticationProvider(saml2iaName, "com.bea.security.saml2.providers.SAML2IdentityAsserter")

cmo.createAuthenticationProvider(samlauthName, "weblogic.security.providers.saml.SAMLAuthenticator")

cd(‘AuthenticationProviders/SAMLAuthenticator')

cmo.setControlFlag(‘SUFFICIENT')

cd(‘../DefaultAuthenticator')

cmo.setControlFlag(‘SUFFICIENT')

save()

activate(block='true')

Tip: in the above script, it changes WLST scripting mode to EDIT before continuing with the real setup. Although it's not absolutely accurate, you can get the clue when you need to click "Lock & Edit" before making the same configuration in GUI console.

The configuration you just made requires server restart, do it using script or manually, depending on how you customized your server startup script. Reconnect to server within WLST console after server restarts.

Now let's configure a WEB SSO partner for the SAML identity asserter created earlier:

iaPath = 'SecurityConfiguration/' + domainName + '/Realms/myrealm/AuthenticationProviders/SAML2IdentityAsserter'

cd (iaPath)

metapartner = cmo.consumeIdPPartnerMetadata(idpMetaFile)

metapartner.setName('WebSSO-IdP-Partner-01')

metapartner.setEnabled(true)

cmo.addIdPPartner(metapartner)

Then setup federation service, which is required when using SAML tokens:

edit()

startEdit()

cd ('/Servers/AdminServer/SingleSignOnServices/AdminServer')

cmo.setContactPersonGivenName('administrator')

cmo.setContactPersonType('administrative')

cmo.setContactPersonCompany('ABC')

cmo.setOrganizationName('ABC')

cmo.setOrganizationURL('www.abc.com')

cmo.setPublishedSiteURL('http://abc.com/saml2')

cmo.setEntityID('AbcServicesProvider')

cmo.setServiceProviderEnabled(true)

cmo.setServiceProviderPreferredBinding('HTTP/POST')

save()

activate(block='true')

Tip: in the above script, the path to the SSO object is not very obvious. If you look at GUI console, it's "Federation Services / SAML 2.0 General". A little imagination helps here.

Great, now you got SAML 2.0 security setup! Configure security policy for your application and you're good to go.

WLST Better than Console
Since WLST is a more direct way to configure WebLogic server, it actually provides the benefit of more accurate results as well. Weblogic console is an application by itself and naturally can contain defects. When you keep on scratching your head because you cannot figure out why a seemingly correct configuration does not work, check it using WLST to find out the reason.

One example is when configuring WSS partner for SAML identity asserter, the "bearer" confirmation method is set but does not work. When checking using WLST, This turns out to be a GUI console defect in WebLogic 10.3.

Summary
Hopefully by now you understand WLST is an important tool for enterprise server configuration and most importantly you can start using it at any point during your project life cycle. You probably already have the necessary knowledge to start using the tool.

This article provides you with some guidance and tips on how to use WLST. It does so by giving an example of configuring SAML 2.0 SSO security, which is more recent technology and there's less examples on it. It shall give you more confidence to start writing scripts on other components as well.

References

• WebLogic Scripting Tool
• WebLogic Server MBean Reference
• Jython:
• SAML 2.0 reference doc

'); for(i = 0; i < google_ads.length; ++i) { document.write('
• '); document.write('' + google_ads[i].line1 + '
  '); document.write('' + google_ads[i].visible_url + '
  '); document.write(google_ads[i].line2 + ' ' + google_ads[i].line3); document.write('
'); } document.write('