Using Sametime Web API features with SSL

by Michael Urspringer - 05.07.2012

If you want to use the Sametime Web API features of the Sametime Standalone or Sametime Embedded Client in Notes if you have enabled SSL for awareness / presence information you need first to do some steps on the client side in order to enable SSL for the Sametime Web API:

  1. Download the Sametime SDK (Software Development Kit)
  2. Extract the files somewhere, for example to C:\STSDK (you only need to extract the folder client/connectWeApi)
  3. Navigate to C:\STSDK\client\connectWebApi\samples\com.ibm.collaboration.realtime.webapi.ssl.feature
  4. Edit the file “ssl.txt” with a text editor
  5. Edit the last two lines so they look like this (make sure they point to the right path where you extracted the files in step #2 above):
    • com.ibm.ssl.trustStore.59669=C\:/STSDK/client/connectWebApi/samples
      /com.ibm.collaboration.realtime.webapi.ssl.feature/testtruststore.jks
    • com.ibm.ssl.keyStore.59669=C\:/STSDK/client/connectWebApi/samples
      /com.ibm.collaboration.realtime.webapi.ssl.feature/testkeystore.jks
    • Attention: You need to escape the “:” with a “\” in Windows and the line breaks above should NOT be there in your file (they are just for displaying it correctly here on the site)
    • The above is only as a demo. You can use your own key and trust store files here (and would need to apply the correct password in this file as well!)
  6. Save the file
  7. Navigate to your workspace config directory. The location is different if you are using the Sametime Standalone Client or the Embedded Client in Notes:
    • Sametime Embedded Client:  <Notes Data Directory>\workspace\.config
    • Sametime Standalone Client: %userprofile%\Application Data\Lotus\Sametime\.config
  8. Open the file “rcpinstall.properties” with a text editor
  9. Add the following two lines to the end of the file (again, make sure you modify the path to point to the location of the ssl.txt file in step 4 above):
    • -Dcom.ibm.pvc.webcontainer.port.secure=59669
    • -Dcom.ibm.pvc.webcontainer.ssl.configfile=C:/STSDK/client/connectWebApi/samples
      /com.ibm.collaboration.realtime.webapi.ssl.feature/ssl.txt
  10. Save the file
  11. Check if there is already a file “webcontainer.properties” in the “.config” directory. If yes, rename it to another name.
  12. If you are using the Sametime Embedded Client in Notes enable the Web API feature (if not already done before).
  13. Now start your Sametime Standalone Client or your Notes Client and log in to Sametime
  14. Wait about 15 seconds after you have successfully logged in.
  15. If you have used a self-signed certificate above, open your browser and go to https://localhost:59669/stwebapi/listservices and accept the self-signed certificate forever

[Thanks to Luis Benitzez]

Tagged with:  

2 Responses to Using Sametime Web API features with SSL

  1. Thanks for this. IBM are not as good as you are when it comes to compacting documentation 🙂

  2. Mats Ekman says:

    Wrote an article on our company blog with a solution on this

    http://www.infoware.eu/open-sametime-meetings-in-ibm-notes-client-using-https-code-for-download

    I also have PMR on its way to third level at IBM

    I think IBM should consider installing this when installing the client

    Regards
    Mats

Leave a Reply

© 2000-2015 Michael Urspringer