Publishers of technology books, eBooks, and videos for creative people

Home > Articles

Exercise 2: The ColdFusion Component, "FCS_Security.cfc"

In this exercise you construct the ColdFusion service methods used by both the Flash Communication Server and Flash Player 6. You will build these service methods inside a ColdFusion Component (not to be confused with the Flash UI Components—they are completely different). These service methods connect with the database you built in Exercise 1. There are three principle methods (or CFFUNCTION objects) required for this project; however, a fourth function is included to help you grow this application.

  1. Create a new file in Dreamweaver MX, or your favourite ColdFusion IDE called "FCS_Security.cfc", and place it within the folder flashcom/applications/informIT. Make sure this folder is mapped from the default web server. (This will be the same web server that you use to access the ColdFusion Administrator.)

  2. Add the following CFCOMPONENT tags to the file. The methods following will be placed within these tags:

<cfcomponent>

<!--- place the cffunction definitions between these tags --->

</cfcomponent>

Method #1: authenticateUser

The authenticateUser function is used by Flash MX to make the initial login/password challenge to the database. It requires two parameters, login and password. This function returns an object to Flash, so the object (ret_obj) is setup, as a ColdFusion structure.

Initial keys (or properties) are set, and then the database query is challenged. This will determine if the login and password matched a record in the database. If a match was found, the function "setTicket" is called to generate a ticket.

The setTicket function is defined after this one. It returns a ColdFusion structure with two keys, TICKET and EXPIRY. When received, these keys are copied into the ret_Obj object that is returned to the Flash Player. Figure 5 shows the complete structure of ret_Obj returned by the authenticateUser function.

   <cffunction name="authenticateUser" access="remote" returntype="any">
     <cfargument name="login"
     type="string" required="yes">
     <cfargument name="password"
     type="string" required="yes">

     <!--- Challange the Login / Password sent from the Flash Player --->
     <CFQUERY NAME="q_checkUser" Datasource="myFlashComDb.mdb">
        SELECT UserID, fname, lname From Users
          WHERE login  = '#arguments.login#'
          AND Password = '#arguments.password#';
     </CFQUERY>
     <CFSCRIPT>
        // Setup return object structure, and set the initial values of the keys
        ret_Obj = structNew();
        ret_Obj.isLoginOK= false;
        ret_Obj.userName = q_checkUser.fname & " " & q_checkUser.lname;

        // Check if the Login & Password received, matched a record in the Db
        if (q_checkUser.recordCount neq 0) {
          // call the cf function, "setTicket" passing it the UserID
          ticketObj = this.setTicket(q_checkUser.UserID);
          // Copy the ticket object into the local ret_obj scope
          ret_Obj.ticket = ticketObj.ticket;
          ret_Obj.expiry = ticketObj.expiry;
          ret_Obj.isLoginOK= true;
        }
        // RETURN the structure. The Flash Remoting Gateway will convert this structure
        // into a valid ActionScript object.
        //The structure's keys will become object properties
        return ret_Obj;
     </CFSCRIPT>
   </cffunction>

Figure 5Figure 5 The ColdFusion Structure returned by the authenticateUser method is assembled automatically by Flash Remoting MX into an ActionScript Object with four properties.

Method #2: setTicket

The setTicket method is not directly called by either the Flash Communication Server or the Flash Player. It is intended to be called by the authenticateUser() method. Its role is to simply generate a ticket and the expiry date. It also stores these values in a separate table in the database. This storage bridges the gap between the Flash Player and Flash Communication Server.

The internal ColdFusion function CreateUUID() will generate a unique value. The Universally Unique IDentifier (UUID) is a 35-character string representation of a unique 128-bit integer. ColdFusion uses the unique time-of-day value, the IEEE 802 Host ID, and a cryptographically strong random number generator to generate UUIDs. It conforms to the principles laid out in the draft IEEE RFC "UUIDs and GUIDs. The ColdFusion UUID format is 8-4-4-16. This might seem a little dense, but I am sure some of you are curious.

The UUID value alone could be your "ticket", but to add one more level of complexity, compound the value with ColdFusion's HASH function. This function converts the UUID to a 32-byte, hexadecimal string using the MD5 algorithm. The MD5 algorithm is not possible to convert back to the source string, and thus provide security for transporting data from client to server.

   <cffunction name="setTicket" access="remote" returntype="any">
     <cfargument name="userID" type="any" required="yes">
     <CFSCRIPT>
         // create a new Ticket Object that will store the ticket info
         ticket_Obj = structNew();
         // set the ticket using CreateUUID and HASH
         ticket_Obj.ticket = Hash(CreateUUID());
         // set the initial expiry Date
         ticket_Obj.expiry = CreateODBCDateTime(DateAdd("yyyy",10,now()));
     </CFSCRIPT>
     <!--- place the ticket into the database. --->
     <CFQUERY NAME="q_setTicket" Datasource="myFlashComDb.mdb">
        INSERT INTO Users_ticket (ticket, UserID, expiry)
        VALUES('#ticket_Obj.ticket#', #arguments.userID#, #ticket_Obj.expiry#);
     </CFQUERY>

     <CFRETURN ticket_Obj>
   </cffunction>

This is only one method you can use to archive the persistent data. Another approach might be to store this information in a persistent server scope such as the Application, Server, Client, or Session Scope.

Method #3: "findTicket"

Now with all that security and encryption technology, a service function is required to match the ticket that will be transferred from Flash to FCS with the user data. This function will be called by the Flash Communication Server. But the API is generic enough that you could use it anywhere.

When called, this function receives a value stored in the "ticket_hash" argument. Using CFQuery, a simple lookup is all you need to do to determine if the ticket is valid. To enforce the expiry date, add a WHERE condition that ensures the ticket is not out-of-date (preventing any hackers from sending bogus tickets to the server).

The following script takes the simple lookup one step further, and using an INNER JOIN, it makes the relationship back to the Users table to capture the first and last name of the user's record.

When the CFQuery is finished, construct a return object (return_obj) structure with two keys, USERNAME and ISTICKETOK. This object with these two keys will be returned to the Flash Communication Server as an ActionScript Object. Figure 6 shows the complete structure of the return_obj.

   <cffunction name="findTicket" access="remote" returntype="any">
     <cfargument name="ticket_hash"
     type="any" required="yes">

     <CFQUERY NAME="q_getUser"
     Datasource="myFlashComDb.mdb">
        SELECT Users.fname, Users.lname
        FROM Users INNER JOIN Users_Ticket
          ON Users.UserID = Users_Ticket.UserID
        WHERE 
            users_Ticket.ticket = '#arguments.ticket_hash#'
            and users_Ticket.expiry > now();
     </CFQUERY>

     <CFSCRIPT>
        return_obj = structNew();
        return_obj.userName = q_getUser.fname & " " & q_getUser.lname;
        if (q_getUser.recordCount neq 0) return_obj.isTicketOK = true;
        else return_obj.isTicketOK = false;

        /* Return the Object to the Caller */
        return return_obj;
     </CFSCRIPT>

   </cffunction>

Figure 6Figure 6 The ColdFusion Structure returned by the findTicket method is assembled automatically by Flash Remoting MX into an ActionScript Object with two properties.

Method #4 (optional): "updateTicket"

This is an optional method that will let you easily update the expiry date of any ticket. Simply pass the ticket and the amount of hours (from now) that the ticket will expire. It could be used in an application.onDisconnect event in SSAS, or by an administrative application. It is not used in this project, but it was built and might be a handy script for some of you.

   <cffunction name="updateTicket" access="remote" returntype="boolean">
     <cfargument name="ticket_hash"
     type="any" required="yes">
     <cfargument name="new_expiry"
     type="numeric" required="false" default="1">

        <CFQUERY NAME="q_getUser" Datasource="myFlashComDb.mdb">
        UPDATE users_Ticket
          set Expiry = #CreateODBCDateTime(DateAdd("h",new_expiry,now()))#
          where ticket = '#ticket_hash#'
        </CFQUERY>

     <CFReturn true>
   </cffunction>

If you would like to test your CFC, you can do so by calling the file within a web browser using this URL: http://localhost/flashcom/applications/informIT/FCS_Security.cfc

Running this file will output a full documentation of the component. You could also test the CFC using the <CFINVOKE> tag or the CreateObject function within a ColdFusion (CFM) file. Now that the ColdFusion Component is ready, let's move on to building the Flash movie.

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.peachpit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020