Meteor Quick Setup Guide Version 1.11

Size: px

Start display at page:

Download "Meteor Quick Setup Guide Version 1.11"

Esmond O’Neal’
6 years ago
Views:

1 Steps for Setting Up Meteor 1. Download the Meteor Software from the Meteor page: in the User Documentation section 2. Install Java SDK (See Appendix A for instructions) o Add [Java root directory]\bin to your PATH environment variable. o Set JAVA_HOME environment variable 3. Install Tomcat (See Appendix B for instructions) 4. Deploy Meteor WAR(s) (See Appendix C for instructions) o Make necessary modifications to.properties files (See Appendix D for instructions) 5. Generate Private and Public Keys (See Appendix E for instructions) o If you re testing, create a self-signed certificate. For production you will need a valid signed certificate from a certificate authority such as Verisign or Thawte. o Add necessary SSL directives to Tomcat configuration files o Add necessary private key information to Meteor.properties files o Send public key for addition to Meteor registry (Meteorhelpdesk@studentclearinghouse.org) 6. Install and Set Up Database (for data provider) o Create database and tables from sql source. Appendix A: Installing Java SDK The Java Development Kit (SDK) can be obtained at: The Meteor Technical Team recommends that you use the latest version SDK that is compatible with your application server. Up to date installation instructions for your environment are available at Downloading the Java Runtime Environment (JRE) is not sufficient to run Tomcat (Tomcat uses the javac executable that is not present in JRE). Appendix B: Installing Tomcat The latest version of Apache Tomcat can be found at: The Meteor Technical Team recommends following the latest installation information at the Tomcat web site for your specific environment. Appendix C: Deploying WAR Files (Tomcat installation) Deploying the METEOR WAR (Web ARchive) files is fairly straightforward. Simply place a copy of the WAR file(s) into the Tomcat webapps directory and start Tomcat. Tomcat automatically decompresses the file and places its contents into the necessary location. 1

2 Appendix D: Modifying.properties Files Your instance of Meteor must be configured before connecting to the Meteor Registry. This is done by modifying the.properties files within the Access/Data/Index provider directories (when initially installed, these files will end in.default to put these files into use, remove the.default suffix). The.properties files are plain text and can be modified using any text editor (e.g. Notepad or TextPad for a Windows environment; Vi or Emacs for a Linux environment). Below are the modifications necessary for each Provider instance and include changes for production and standalone environments. If a file does not exist within the specified directory, it must be created. Please refer to the Meteor 3.3 Release Notes for more detailed information about the individual attributes in each of the property files discussed below. Required Files The files required for each provider are as follows: Access Provider (found in %TOMCAT_HOME%\webapps\AccessProvider\WEB-INF\classes) o accessprovider.properties o authentication.properties o directory.properties * o directorydata.properties ** Data Provider (found in %TOMCAT_HOME%\webapps\DataProvider\WEB-INF\classes) o dataprovider.properties *** o directory.properties * o directorydata.properties ** Index Provider (found in %TOMCAT_HOME\webapps\IndexProvider\WEB-INF\classes) o indexprovider.properties o directorydata.properties ** o directory.properties * * identical files (directory.properties used in Access and Data Providers) ** identical files (directorydata.properties Never Use This File in Production - used in Access, Data and Index Providers is not needed if connecting to an LDAP server) *** identical files (dataprovider.properties used in Index and Data Providers) Configuring AccessProvider AccessProvider.properties files can be found in [Path\to\Tomcat]\webapps\AccessProvider\WEB- INF\classes. Production Settings: accessprovider.properties meteor.default.institution=[your Meteor Org ID] (no longer used in Meteor 3.0 and higher) dataprovider.timeout=20000 (default) meteor.authentication.requirepassedassertion=no (default) meteor.backgroundprocessing=yes (default) meteor.authentication.acceptassertions=no (default) meteor.user.authentication.class=org.nchelp.meteor.provider.access.servletremoteuser (default) meteor.user.role.class=(see comments in the property file before setting this 2

3 meteor.user.ssn.class=(see comments in the property file before setting this meteor.user.lenderid.class=(see comments in the property file before setting this meteor.user.organizationtype.class=(see comments in the property file before setting this meteor.user.organizationopeid.class=(see comments in the property file before setting this meteor.user.organizationopeidtype.class=(see comments in the property file before setting this meteor.status.servletpath=/status (default) Configuring AccessProvider (continued) directory.properties directory.class=org.nchelp.meteor.registry.ldapdirectory (default) ssl.protocol.handler=com.sun.net.ssl.internal. (default) ssl.protocol.provider=com.sun.net.ssl.internal.ssl.provider (default) authentication.requiresignedassertions=yes (default) directory.providerurl=ldap://ldap.meteorregistry.com:636 (default) directory.basedn=o=meteorcentral.com (default) directory.protocol=custom (default) authentication.properties authentication.identifier=[your Meteor Org ID] authentication.process.identifier=1 (default) authentication.saml.validity.period=14400 (default) authentication.message.validity.period=15(default) authentication.signassertion=yes(default) authentication.keystore.file=[path\to\your\keystore] authentication.keystore.password=[your Keystore Password] authentication.privatekey.alias=[your Keystore Alias] authentication.privatekey.password=[your Private Key Password] authentication.certificate.alias=[your Public Key Alias] authentication.certificate.include=false (default) Configuring AccessProvider (continued) Stand-alone Settings: accessprovider.properties meteor.default.institution=[your Meteor Org ID] (No longer used in Meteor 3.0) dataprovider.timeout=20000 (default) meteor.authentication.requirepassedassertion=no (default) meteor.backgroundprocessing=yes (default) meteor.authentication.acceptassertions=yes meteor.user.authentication.class=org.nchelp.meteor.provider.access.servletremoteuser (default) meteor.user.role.class=(see comments in the property file before setting this meteor.user.ssn.class=(see comments in the property file before setting this meteor.user.lenderid.class=(see comments in the property file before setting this meteor.user.organizationtype.class=(see comments in the property file before setting this meteor.user.organizationopeid.class=(see comments in the property file before setting this meteor.user.organizationopeidtype.class=(see comments in the property file before setting this meteor.status.servletpath=/status (default) meteor.user.role.class=org.nchelp.meteor.provider.access.faarole (default) 3

4 directory.properties directory.class=org.nchelp.meteor.registry.propertiesdirectory ssl.protocol.handler=com.sun.net.ssl.internal. (default) ssl.protocol.provider=com.sun.net.ssl.internal.ssl.provider (default) authentication.requiresignedassertions=yes (default) directory.providerurl=ldap://ldap.meteorregistry.com:636 (default) directory.basedn=o=meteorcentral.com (default) directory.protocol=custom (default) authentication.properties authentication.identifier=[your Meteor Org ID] authentication.process.identifier=1 (default) authentication.saml.validity.period=14400 (default) authentication.message.validity.period=15 (default) authentication.signassertion=yes (default) authentication.keystore.file=[path\to\your\keystore] authentication.keystore.password=[your Keystore Password] authentication.privatekey.alias=[your Keystore Alias] authentication.privatekey.password=[your Private Key Password] authentication.certificate.alias=[your Public Key Alias] authentication.certificate.include=false (default) directorydata.properties If this file does not exist within [Path\to\Tomcat]\webapps\AccessProvider\WEB-INF\classes, you must create it. An exact copy of this file should also be placed within the DataProvider \WEB- INF\classes directory. [Your Meteor Org ID].NAME=[Name of Your Org] [Your Meteor Org ID].AuthenticationLevel=3 [Your Meteor Org ID].APCSR.AuthenticationLevel=3 [Your Meteor Org ID].BORROWER.AuthenticationLevel=3 [Your Meteor Org ID].FAA.AuthenticationLevel=3 [Your Meteor Org ID].LENDER.AuthenticationLevel=3 [Your Meteor Org ID].AuthenticationProcessID=1 [Your Meteor Org ID].AccessProvider.URL= [Your Meteor Org ID].IndexProvider.URL= [Your Meteor Org ID].DataProvider.URL= [Your Meteor Org ID].AccessProvider.Status=AC [Your Meteor Org ID].DataProvider.Status=AC [Your Meteor Org ID].IndexProvider.Status=AC [Your Meteor Org ID].Certificate=[Path\to\your\public\key] IndexProvider.1=[Your Meteor Org ID] 4

5 Configuring DataProvider DataProvider.properties files can be found in [Path\to\Tomcat]\webapps\DataProvider\WEB-INF\classes. Sample settings are included for both MySQL and XML files. Note: If you are using MySQL, the MySQL JDBC connector must be placed in [Path\to\Tomcat]\webapps\DataProvider\WEB-INF\lib. Production Settings: dataprovider.properties If you are using MySQL for your data use the following: default.data.server=com.prioritytech.meteor.sampledataserver com.prioritytech.sample.jdbcclass=org.gjt.mm.mysql.driver com.prioritytech.sample.jdbcurl=jdbc:mysql://localhost:3306/meteor_g?relaxautocommit=true (Here the IP address of the database server is localhost. Change it to your database IP address. Here the name of the database is meteor_g. Change it to your database s name) com.prioritytech.sample.jdbcuserid=[mysql User Name] (Use root if you have not assigned a user name) com.prioritytech.sample.jdbcpassword=[mysql Password] accessprovider.minimum.authentication.level=3 (default) DataProvider.request.signaturerequired=No (default) DataProvider.Data.Name=[The Full Name of Your Organization] DataProvider.Data.ID=[Your Meteor Org ID] DataProvider.Data.URL=[Your Org URL like DataProvider.Data.Type=[select either SBS, LO, LRS, or G] DataProvider.Data.Contacts.PhoneNum=[Your Contact Phone Number] DataProvider.Data.Contacts. =[Your Contact Address] DataProvider.Data.Contacts.Addr=[Your Street Address] DataProvider.Data.Contacts.Addr2=[Your Street Address Cont d] DataProvider.Data.Contacts.City=[Your City] DataProvider.Data.Contacts.StateProv=[Your State] DataProvider.Data.Contacts.PostalCd=[Your Zipcode] directory.properties directory.class=org.nchelp.meteor.registry.ldapdirectory (default) ssl.protocol.handler=com.sun.net.ssl.internal. (default) ssl.protocol.provider=com.sun.net.ssl.internal.ssl.provider (default) authentication.requiresignedassertions=yes (default) directory.providerurl=ldap://ldap.meteorregistry.com:636 directory.basedn=o=meteorcentral.com (default) directory.protocol=custom (default) authentication.properties authentication.saml.validity.period=14400 (default) authentication.message.validity.period=15 (default) Stand-alone Settings: dataprovider.properties If you are using MySQL for your data (instead of XML files), use the following: default.data.server=com.prioritytech.meteor.sampledataserver com.prioritytech.sample.jdbcclass=org.gjt.mm.mysql.driver com.prioritytech.sample.jdbcurl=jdbc:mysql://localhost:3306/meteor_g?relaxautocommit=true (Here the IP address of the database server is localhost. Change it to your database IP address. Here the name of the database is meteor_g. Change it to your database s name) com.prioritytech.sample.jdbcuserid=[mysql User Name] (Use root if you have not assigned a user name) com.prioritytech.sample.jdbcpassword=[mysql Password] 5

6 accessprovider.minimum.authentication.level=3 (default) DataProvider.request.signaturerequired=No (default) DataProvider.Data.Name=[The Full Name of Your Organization] DataProvider.Data.ID=[Your Meteor Org ID] DataProvider.Data.URL=[Your Org URL like DataProvider.Data.Type=[select either SBS, LO, LRS, or G] DataProvider.Data.Contacts.PhoneNum=[Your Contact Phone Number] DataProvider.Data.Contacts. =[Your Contact Address] DataProvider.Data.Contacts.Addr=[Your Street Address] DataProvider.Data.Contacts.Addr2=[Your Street Address Cont d] DataProvider.Data.Contacts.City=[Your City] DataProvider.Data.Contacts.StateProv=[Your State] DataProvider.Data.Contacts.PostalCd=[Your Zipcode] If you are using the XML files for your data (instead of MySQL), use the following: default.data.server=com.prioritytech.meteor.filedataprovider com.prioritytech.file.directory=[path\to\xml\test\data] com.prioritytech.file.format=testcase%{9} directory.properties directory.class=org.nchelp.meteor.registry.propertiesdirectory ssl.protocol.handler=com.sun.net.ssl.internal. (default) ssl.protocol.provider=com.sun.net.ssl.internal.ssl.provider (default) authentication.requiresignedassertions=yes (default) directory.providerurl=ldap://ldap.meteorregistry.com:636 directory.basedn=o=meteorcentral.com (default) directory.protocol=custom (default) directorydata.properties Exact copies of this file should also be place within the IndexProvider and AccessProvider \WEB- INF\classes directories. [Your Meteor Org ID].NAME=[Name of Your Org] [Your Meteor Org ID].AuthenticationLevel=3 [Your Meteor Org ID].APCSR.AuthenticationLevel=3 [Your Meteor Org ID].BORROWER.AuthenticationLevel=3 [Your Meteor Org ID].FAA.AuthenticationLevel=3 [Your Meteor Org ID].LENDER.AuthenticationLevel=3 [Your Meteor Org ID].AuthenticationProcessID=1 [Your Meteor Org ID].AccessProvider.URL= [Your Meteor Org ID].IndexProvider.URL= [Your Meteor Org ID].DataProvider.URL= [Your Meteor Org ID].AccessProvider.Status=AC [Your Meteor Org ID].DataProvider.Status=AC [Your Meteor Org ID].IndexProvider.Status=AC [Your Meteor Org ID].Certificate=[Path\to\your\public\key] IndexProvider.1=[Your Meteor Org ID] Configuring IndexProvider This configuration is for a stand-alone environment only. These files can be found in [Path\to\Tomcat]\webapps\IndexProvider\WEB-INF\classes. indexprovider.properties IndexProvider.ID=[Your Meteor Org ID] (with the same institution ID used in the AccessProvider configuration) IndexProvider.Name=[Your Org Name] 6

7 IndexProvider.URL=[Your Org URL] IndexProvider.Sample.Include.Details=Yes (default) IndexProvider.request.signaturerequired=No (default) directorydata.properties Exact copies of this file should also be place within the DataProvider and AccessProvider \WEB- INF\classes directories. [Your Meteor Org ID].NAME=[Name of Your Org] [Your Meteor Org ID].AuthenticationLevel=3 [Your Meteor Org ID].APCSR.AuthenticationLevel=3 [Your Meteor Org ID].BORROWER.AuthenticationLevel=3 [Your Meteor Org ID].FAA.AuthenticationLevel=3 [Your Meteor Org ID].LENDER.AuthenticationLevel=3 [Your Meteor Org ID].AuthenticationProcessID=1 [Your Meteor Org ID].AccessProvider.URL= [Your Meteor Org ID].IndexProvider.URL= [Your Meteor Org ID].DataProvider.URL= [Your Meteor Org ID].AccessProvider.Status=AC [Your Meteor Org ID].DataProvider.Status=AC [Your Meteor Org ID].IndexProvider.Status=AC [Your Meteor Org ID].Certificate=[Path\to\your\public\key] IndexProvider.1=[Your Meteor Org ID] Appendix E: Public & Private Keys and Certificates Key generation is handled by Java keytool. Step 1: Generate a keystore and key entry From the command line, locate your Java /bin directory (can be found at JAVA_HOME/bin) and enter the following: keytool genkey keyalg RSA alias meteor keystore [keystore name] You will be asked to enter a keystore password. Choose a password and enter it when prompted to do so. Next, you will be asked a series of questions regarding your organization. Enter your response for each question (questions are in bold and example answers are in italics). What is your first and last name? [Unknown] (actually your domain name) What is the name of your organizational unit? [Unknown] Web Development What is the name of your Organization? [Unknown] Acme Inc What is the name of your City or Locality? [Unknown] New York City What is the name of your State or Province? [Unknown] New York What is the two-letter country code for this unit? [Unknown] US Is CN= OU=Web Development, O=Acme Inc, L=New York City, ST=New York, C=US correct? [no] yes 7

8 Enter key password for <meteor>: (Return if same as keystore password) Specify the same password for the keystore and the key entry. Otherwise, you ll receive the following error message when you restart the Jakarta engine: java.security.unrecoverablekeyexception: Cannot recover key Lastly, verify that your keystore was created. Run: keytool list keystore [keystore name] They keystore will be stored in your Java SDK/bin directory (or if in a Windows environment, it will be saved to your Documents and Settings folder e.g. c:\documents and Settings\zorro\.keystore). It is recommended that you make a backup copy of your keystore file and keep it in the event of a server crash. If you are setting up a stand-alone Meteor system, you can self-sign your certificate (and skip steps 2-4): keytool selfcert keystore [keystore name] alias meteor Self-signed certificates can only be used in a stand-alone or testing environment but are not required. You must obtain a certificate from Thawte or Verisign to participate in Meteor. Steps 2-4 will guide you through the process of creating a certificate signing request (CSR) and importing a sign certificate. Step 2: Generate a CSR of the newly created keystore and keyentry Generate the Certificate Signing Request with: keytool certreq alias meteor keyalg RSA file certreq.csr keystore [keystore name] Enter the keystore password when prompted. The CSR file will be saved to your Java SDK/bin directory (or if in a Windows environment, it will be saved to your Documents and Settings folder e.g. c:\documents and Settings\zorro\certreq.csr). Step 3: Submit your CSR to a signing authority (e.g. Verisign or Thawte) Step 4: Import your signed certificate into your keystore (must be in PKCS#7 format) Import the certificate into your keystore file: keytool import alias meteor trustcerts file cert.crt keystore [keystore name] where cert.crt is your certificate file. If you receive the error unsupported encoding, add a line break after the last line in the certificate (this can be done in notepad or an equivalent text editor), as keytool is very sensitive to white space. Step 5: Export your public key Your public key is used in the Meteor registry to verify communication with your server. You will need to export your public key and send it during the Meteor registration process. Export your key: 8

9 keytool export alias meteor file [public key name].key keystore [keystore name] where [public key name].key is the public key file name. When prompted, enter your keystore password. Press Enter and see the Certificate Stored message. Your public key file will be saved to the Java SDK/bin directory (or if in a Windows environment, it will be saved to your Documents and Settings folder e.g. c:\documents and Settings\zorro\[public key name].key) Document Change Log Date Version Person Changes 1/6/ Mike Mazanec Initial Release 1/25/ Mike Mazanec Added Appendices D (Deploying WARS) & E (.properties modifications) 1/27/ Mike Mazanec Added standalone.properties modifications, SDk-specific changes and JSSE installation 1/31/ Mike Mazanec Added.properties notes for version 3.0 2/14/ Mike Mazanec Corrected typo for JAVA_HOME 2/ Mike Mazanec Updated.properties changes 2/23/ Mike Mazanec Fixed typos, added properties for XML Data Provider data (vs. MySQL) and Access Provider keystore and modifications for Access Provider web.xml (for use with SAML) 2/25/ Mike Mazanec Added directions for self-signing the certificate, changed directorydata.properties modifications, added in-document hyperlinks from TOC 3/16/ Mike Mazanec Removed directions for creating CATALINA_HOME, lines for using SampleDataServer and FileDataProvider for DP and notes regarding the MySQL connector and self-signed certificates. 4/7/ Mike Mazanec Modified Appendix F to reflect.default suffix on property files, and Appendix E to reflect Tomcat 5.x doesn t need JAR files 5/11/ Tech Team Revised to make current and checked for accuracy 03/12/ Chris Cooper Revised for changes to Meteor v3.3 03/12/ Rick Allen Revised after Tech Team conference call 03/17/ Tech Team Revised after Tech Team conference call 03/19/ Tech Team Revised after Tech Team conference call 5/11/ Tim Cameron Updated logo and NCHELP references. 9

Creating an authorized SSL certificate

Creating an authorized SSL certificate for MeetingSphere Meeting Center Server MeetingSphere Meeting Center Server requires an authorized SSL certificate by which its Meeting center is identified, and