mod_flash_policy/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Alpha'
   4 summary: Adds support for flash socket policy
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 This Prosody plugin adds support for flash socket policies. When
  11 connecting with a flash client (from a webpage, not an exe) to prosody
  12 the flash client requests for an xml "file" on port 584 or the
  13 connecting port (5222 in the case of default xmpp). Responding on port
  14 584 is tricky because it requires root priviliges to set up a socket on
  15 a port \< 1024.
  16
  17 This plugins filters the incoming data from the flash client. So when
  18 the client connects with prosody it immediately sends a xml request
  19 string (`<policy-file-request/>\0`). Prosody responds with a flash
  20 cross-domain-policy. See
  21 http://www.adobe.com/devnet/flashplayer/articles/socket\_policy\_files.html
  22 for more information.
  23
  24 Usage
  25 =====
  26
  27 Add "flash\_policy" to your modules\_enabled list.
  28
  29 Configuration
  30 =============
  31
  32   --------------------- --------------------------------------------------------------------------------
  33   crossdomain\_file     Optional. The path to a file containing an cross-domain-policy in xml format.
  34   crossdomain\_string   Optional. A cross-domain-policy as string. Should include the xml declaration.
  35   --------------------- --------------------------------------------------------------------------------
  36
  37 Both configuration options are optional. If both are not specified a
  38 cross-domain-policy with "`<allow-access-from domain="*" />`" is used as
  39 default.
  40
  41 Compatibility
  42 =============
  43
  44   ----- -------
  45   0.7   Works
  46   ----- -------
  47
  48 Caveats/Todos/Bugs
  49 ==================
  50
  51 -   The assumption is made that the first packet received will always
  52     contain the policy request data, and all of it. This isn't robust
  53     against fragmentation, but on the other hand I highly doubt you'll
  54     be seeing that with such a small packet.
  55 -   Only tested by me on a single server :)