Difference between revisions of "LlGenerateKey"

From Second Life Wiki
Jump to: navigation, search
m (Stripping library code)
m
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{LSL_Function
 
{{LSL_Function
 
|func=llGenerateKey
 
|func=llGenerateKey
|func_desc=Generates a key using Type 3 (MD5) UUID generation to create a unique key using region-name, object-key, service and variable.
+
|func_desc=Generates a key using [http://en.wikipedia.org/wiki/UUID#Version_5_.28SHA-1_hash.29 Version 5 (SHA-1 hash)] [[UUID]] generation to create a unique key.
 
|return_type=key
 
|return_type=key
 
|Return_text=generated.
 
|Return_text=generated.
|p1_type=string|p1_name=service|p1_desc=The service, object, function, or whatever else this key may represent.
+
|caveats=
|p2_type=string|p2_name=variable|p2_desc=Any variable(s) relevant to the service that uniquely distinguish it.
+
*The specific UUID version is an implementation detail that has changed in the past and may change again in the future. Do not depend upon the UUID that is returned to be Version 5.
|mode=pre-release
+
*As the UUID produced is versioned, it should never return a value of [[NULL_KEY]].
|examples=In a two-prim linked-set put the following script (adding generateKey where noted) into the child-prim:<lsl>integer requestID = 0;
+
|mode
 +
|examples=
 +
<source lang="lsl2">
 +
default
 +
{
 +
    touch_start(integer num_detected)
 +
    {
 +
        // avatar touching
 +
        key avatarKey = llDetectedKey(0);
 +
        string avatarName = llKey2Name(avatarKey);
  
default {
+
        // key of the owner
    touch_start(integer x) {
+
         key owner = llGetOwner();
         llMessageLinked(
+
            LINK_ROOT,
+
            1234,
+
            "I am a request",
+
            llGenerateKey("echo", (string)requestID++)
+
        );
+
    }
+
  
    link_message(integer x, integer y, string msg, key id) {
+
        // generated random key
         if (y == 1234)  
+
        key random = llGenerateKey();
             llOwnerSay("Request: " + (string)id + " = " + msg);
+
 
     }
+
        // number of objects inside the same prim
}</lsl>And the following script in the root-prim:<lsl>default {
+
        integer numberOfObjects = llGetInventoryNumber(INVENTORY_OBJECT);
    link_message(integer x, integer y, string msg, key id) {
+
 
        if (y == 1234) // Echo, send straight back
+
         if (numberOfObjects)
             llMessageLinked(x, y, msg, id);
+
        {
 +
            // name of first object sorted by name inside the prim's inventory
 +
            string itemName = llGetInventoryName(INVENTORY_OBJECT, 0);
 +
   
 +
             llGiveInventory(avatarKey, itemName);
 +
            llInstantMessage(avatarKey, "Your transaction key is '" + (string)random + "'.");
 +
      
 +
            llInstantMessage(owner, "Transaction record:\n"
 +
                + "receiver: " + avatarName + " (" + (string)avatarKey + ")\n"
 +
                + "item: " + itemName + "\n"
 +
                + "transaction key: " + (string)random);
 +
        }
 +
        else
 +
        {
 +
            // PUBLIC_CHANNEL has the integer value 0
 +
             llSay(PUBLIC_CHANNEL, "No items to give away, sorry!");
 +
        }
 
     }
 
     }
}</lsl>Simply touch the child-prim to use, enjoy!
+
}
 +
</source>
 
|cat1=Key
 
|cat1=Key
|cat2=Encryption
+
|cat2
}}
+
|history=*Inspired by the library function [[generateKey]].
 +
*Changed from using [http://en.wikipedia.org/wiki/UUID#Version_3_.28MD5_hash.29 Version 3 (MD5 hash)] to [http://en.wikipedia.org/wiki/UUID#Version_5_.28SHA-1_hash.29 Version 5 (SHA-1 hash)]. Date of this change is unknown.
 +
}}{{LSLC{{#var:lang}}|Encryption|llGenerateKey}}

Latest revision as of 01:30, 22 January 2015

Summary

Function: key llGenerateKey( );

Generates a key using Version 5 (SHA-1 hash) UUID generation to create a unique key.
Returns the key generated.

Caveats

  • The specific UUID version is an implementation detail that has changed in the past and may change again in the future. Do not depend upon the UUID that is returned to be Version 5.
  • As the UUID produced is versioned, it should never return a value of NULL_KEY.
All Issues ~ Search JIRA for related Bugs

Examples

default
{
    touch_start(integer num_detected)
    {
        // avatar touching
        key avatarKey = llDetectedKey(0);
        string avatarName = llKey2Name(avatarKey);
 
        // key of the owner
        key owner = llGetOwner();
 
        // generated random key
        key random = llGenerateKey();
 
        // number of objects inside the same prim
        integer numberOfObjects = llGetInventoryNumber(INVENTORY_OBJECT);
 
        if (numberOfObjects)
        {
            // name of first object sorted by name inside the prim's inventory
            string itemName = llGetInventoryName(INVENTORY_OBJECT, 0);
 
            llGiveInventory(avatarKey, itemName);
            llInstantMessage(avatarKey, "Your transaction key is '" + (string)random + "'.");
 
            llInstantMessage(owner, "Transaction record:\n"
                + "receiver: " + avatarName + " (" + (string)avatarKey + ")\n"
                + "item: " + itemName + "\n"
                + "transaction key: " + (string)random);
        }
        else
        {
            // PUBLIC_CHANNEL has the integer value 0
            llSay(PUBLIC_CHANNEL, "No items to give away, sorry!");
        }
    }
}

Deep Notes

History

Search JIRA for related Issues

Signature

function key llGenerateKey();