Changeset 2927


Ignore:
Timestamp:
05/10/07 10:43:44 (12 years ago)
Author:
pjkersha
Message:

epydoc @keyword changed to @param. @keyword only applies to keywords not otherwise explicitly listed when passed with kw

Location:
TI12-security/trunk
Files:
15 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/AttAuthority/__init__.py

    r2926 r2927  
    7979        """ 
    8080        @type uri: string 
    81         @keyword uri: URI for Attribute Authority WS.  Setting it will also 
     81        @param uri: URI for Attribute Authority WS.  Setting it will also 
    8282        initialise the Service Proxy 
    8383                                          
    84         @keyword tracefile: set to file object such as sys.stderr to give  
     84        @param tracefile: set to file object such as sys.stderr to give  
    8585        extra WS debug information 
    8686         
    8787        @type sslCACertList: list 
    88         @keyword sslCACertList: This keyword is for use with SSL connections  
     88        @param sslCACertList: This keyword is for use with SSL connections  
    8989        only.  Set a list of one ore more CA certificates.  The peer cert. 
    9090        must verify against at least one of these otherwise the connection 
     
    9292         
    9393        @type sslCACertFilePathList: list 
    94         @keyword sslCACertFilePathList: the same as the above except CA certs 
     94        @param sslCACertFilePathList: the same as the above except CA certs 
    9595        can be passed as a list of file paths to read from 
    9696         
    9797        @type sslPeerCertCN: string 
    98         @keyword sslPeerCertCN: set an alternate CommonName to match with peer 
     98        @param sslPeerCertCN: set an alternate CommonName to match with peer 
    9999        cert.  This keyword is for use with SSL connections only. 
    100100                      
     
    247247         
    248248        @type uri: string 
    249         @keyword uri: URI for service to invoke""" 
     249        @param uri: URI for service to invoke""" 
    250250         
    251251        if uri: 
     
    346346         
    347347        @type userId: string 
    348         @keyword userId: DN of the X.509 certificate used in SOAP digital  
     348        @param userId: DN of the X.509 certificate used in SOAP digital  
    349349        signature corresponds to the *holder* of the Attribute Certificate 
    350350        that is issued.  Set this additional field to specify an alternate 
     
    357357         
    358358        @type userCert: string 
    359         @keyword userCert: certificate corresponding to proxy private key and 
     359        @param userCert: certificate corresponding to proxy private key and 
    360360        proxy cert used to sign the request.  Enables server to establish 
    361361        chain of trust proxy -> user cert -> CA cert.  If a standard  
     
    364364         
    365365        @type userAttCert: string / AttCert 
    366         @keyword userAttCert: user attribute certificate from which to make a  
     366        @param userAttCert: user attribute certificate from which to make a  
    367367        mapped certificate at the target attribute authority.  userAttCert 
    368368        must have been issued from a trusted host to the target.  This is not  
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/CredWallet.py

    r2909 r2927  
    8989         
    9090        @type extAttCertList: list 
    91         @keyword extAttCertList: list of candidate Attribute Certificates that 
     91        @param extAttCertList: list of candidate Attribute Certificates that 
    9292        could be used to try to get a mapped certificate from the target  
    9393        Attribute Authority 
    9494         
    9595        @type trustedHostInfo: dict  
    96         @keyword trustedHostInfo: dictionary indexed by host name giving  
     96        @param trustedHostInfo: dictionary indexed by host name giving  
    9797        details of Attribute Authority URI and roles for trusted hosts""" 
    9898         
     
    187187         
    188188        @type aaURI: string 
    189         @keyword aaURI: URI of Attribute Authority to make requests to.   
     189        @param aaURI: URI of Attribute Authority to make requests to.   
    190190        Setting this ALSO creates an AttAuthorityClient instance  
    191191        self.__aaClnt.  - See aaURI property for details. 
    192192         
    193193        @type aaPropFilePath: string 
    194         @keyword aaPropFilePath: properties file path for an Attribute  
     194        @param aaPropFilePath: properties file path for an Attribute  
    195195        Authority to make requests to.  Setting this ALSO creates an  
    196196        AttAuthority instance self.__aa running locally.   - See aa property  
     
    200200         
    201201        @type caCertFilePath: string 
    202         @keyword caCertFilePath: Certificate Authority's certificate - used in 
     202        @param caCertFilePath: Certificate Authority's certificate - used in 
    203203        validation of signed Attribute Certificates.  If not set here, it must 
    204204        be input in call to getAttCert. 
    205205                 
    206206        @type credRepos: instance of CredRepos derived class 
    207         @keyword credRepos: Credential Repository instance.  If not set,  
     207        @param credRepos: Credential Repository instance.  If not set,  
    208208        defaults to NullCredRepos type - see class below... 
    209209         
    210210        @type mapFromTrustedHosts: bool 
    211         @keyword mapFromTrustedHosts sets behaviour for getAttCert().  If 
     211        @param mapFromTrustedHosts sets behaviour for getAttCert().  If 
    212212        set True and authorisation fails with the given Attribute Authority,  
    213213        attempt to get authorisation using Attribute Certificates issued by  
     
    215215         
    216216        @type rtnExtAttCertList: bool 
    217         @keyword rtnExtAttCertList: behaviour for getAttCert().  If True, and  
     217        @param rtnExtAttCertList: behaviour for getAttCert().  If True, and  
    218218        authorisation fails with the given Attribute Authority, return a list  
    219219        of Attribute Certificates from other trusted AAs which could be used  
     
    222222         
    223223        @type attCertRefreshElapse: float / int 
    224         @keyword attCertRefreshElapse: used by getAttCert to determine  
     224        @param attCertRefreshElapse: used by getAttCert to determine  
    225225        whether to replace an existing AC in the cache with a fresh one.  If  
    226226        the existing one has less than attCertRefreshElapse time in seconds 
     
    531531        @param attCert: new attribute Certificate to be added 
    532532        @type bUpdateCredRepos: bool 
    533         @keyword bUpdateCredRepos: if set to True, and a repository exists it  
     533        @param bUpdateCredRepos: if set to True, and a repository exists it  
    534534        will be updated with the new credentials also 
    535535         
     
    614614         
    615615        @type auditCred: bool 
    616         @keyword auditCred: filter existing credentials in the repository 
     616        @param auditCred: filter existing credentials in the repository 
    617617        removing invalid ones""" 
    618618 
     
    652652         
    653653        @type extAttCert: ndg.security.common.AttCert.AttCert 
    654         @keyword extAttCert: an existing Attribute Certificate which can  
     654        @param extAttCert: an existing Attribute Certificate which can  
    655655        be used to making a mapping should the user not be registered with the 
    656656        Attribute Authority""" 
     
    723723                    
    724724        @type userRole: string 
    725         @keyword userRole: get hosts which have a mapping to this role 
     725        @param userRole: get hosts which have a mapping to this role 
    726726         
    727727        @type aaURI: string 
    728         @keyword aaURI: to call as a web service, specify the URI for the  
     728        @param aaURI: to call as a web service, specify the URI for the  
    729729        Attribute Authority. 
    730730         
    731731        @type aaPropFilePath: string 
    732         @keyword aaPropFilePath: Altenrative to aaURI - to run on the local  
     732        @param aaPropFilePath: Altenrative to aaURI - to run on the local  
    733733        machine, specify the local Attribute Authority configuration file. 
    734734        """ 
     
    807807                     
    808808        @type reqRole: string 
    809         @keyword reqRole: the required role to get access for 
     809        @param reqRole: the required role to get access for 
    810810         
    811811        @type aaURI: string 
    812         @keyword aaURI: to call as a web service, specify the URI for the  
     812        @param aaURI: to call as a web service, specify the URI for the  
    813813        Attribute Authority. 
    814814         
    815815        @type aaPropFilePath: string 
    816         @keyword aaPropFilePath: Altenrative to aaURI - to run on the local  
     816        @param aaPropFilePath: Altenrative to aaURI - to run on the local  
    817817        machine, specify the local Attribute Authority configuration file. 
    818818                                 
    819819        @type mapFromTrustedHosts: bool / None      
    820         @keyword mapFromTrustedHosts: if request fails via the user's proxy 
     820        @param mapFromTrustedHosts: if request fails via the user's proxy 
    821821        ID, then it is possible to get a mapped certificate by using  
    822822        certificates from other AA's.  Set this flag to True, to allow this  
     
    837837 
    838838        @type rtnExtAttCertList: bool / None 
    839         @keyword rtnExtAttCertList: If request fails, make a list of  
     839        @param rtnExtAttCertList: If request fails, make a list of  
    840840        candidate certificates from other Attribute Authorities which the user 
    841841        could use to retry and get a mapped certificate. 
     
    851851                                 
    852852        @type extAttCertList: list 
    853         @keyword extAttCertList: Attribute Certificate or list of certificates 
     853        @param extAttCertList: Attribute Certificate or list of certificates 
    854854        from other Attribute Authorities.  These can be used to get a mapped  
    855855        certificate if access fails based on the user's proxy certificate 
     
    858858 
    859859        @type extTrustedHostList: 
    860         @keyword extTrustedHostList: same as extAttCertList keyword, but  
     860        @param extTrustedHostList: same as extAttCertList keyword, but  
    861861        instead of providing Attribute Certificates, give a list of Attribute  
    862862        Authority hosts.  These will be matched up to Attribute Certificates  
     
    865865         
    866866        @type refreshAttCert: bool 
    867         @keyword refreshAttCert: if set to True, the attribute request  
     867        @param refreshAttCert: if set to True, the attribute request  
    868868        will go ahead even if the wallet already contains an Attribute  
    869869        Certificate from the target Attribute Authority.  The existing AC in  
     
    875875         
    876876        @type attCertRefreshElapse: float / int 
    877         @keyword attCertRefreshElapse: determine whether to replace an  
     877        @param attCertRefreshElapse: determine whether to replace an  
    878878        existing AC in the cache with a fresh one.  If the existing one has  
    879879        less than attCertRefreshElapse time in seconds left before expiry then 
     
    11211121 
    11221122        @type dbPPhrase: string 
    1123         @keyword dbPPhrase: pass-phrase to database if applicable 
     1123        @param dbPPhrase: pass-phrase to database if applicable 
    11241124         
    11251125        @type propFilePath: string 
    1126         @keyword propFilePath: file path to a properties file.  This could  
     1126        @param propFilePath: file path to a properties file.  This could  
    11271127        contain configuration parameters for the repository e.g.  database  
    11281128        connection parameters 
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/SessionMgr/__init__.py

    r2909 r2927  
    6666         
    6767        @type extAttCertList: list 
    68         @keyword extAttCertList: list of candidate Attribute Certificates that 
     68        @param extAttCertList: list of candidate Attribute Certificates that 
    6969        could be used to try to get a mapped certificate from the target  
    7070        Attribute Authority""" 
     
    124124        """ 
    125125        @type uri: string 
    126         @keyword uri: URI for Session Manager WS.  Setting it will set the  
     126        @param uri: URI for Session Manager WS.  Setting it will set the  
    127127        Service Proxy 
    128128                 
     
    132132         
    133133        @type sslCACertList: list 
    134         @keyword sslCACertList: This keyword is for use with SSL connections  
     134        @param sslCACertList: This keyword is for use with SSL connections  
    135135        only.  Set a list of one or more CA certificates.  The peer cert. 
    136136        must verify against at least one of these otherwise the connection 
     
    138138         
    139139        @type sslCACertFilePathList: list 
    140         @keyword sslCACertFilePathList: the same as the above except CA certs 
     140        @param sslCACertFilePathList: the same as the above except CA certs 
    141141        can be passed as a list of file paths to read from 
    142142         
    143143        @type sslPeerCertCN: string 
    144         @keyword sslPeerCertCN: set an alternate CommonName to match with peer 
     144        @param sslPeerCertCN: set an alternate CommonName to match with peer 
    145145        cert.  This keyword is for use with SSL connections only. 
    146146         
     
    359359         
    360360        @type passphrase: string 
    361         @keyword passphrase: user's pass-phrase 
     361        @param passphrase: user's pass-phrase 
    362362         
    363363        @type passphraseFilePath: string 
    364         @keyword passphraseFilePath: a file containing the user's pass-phrase.   
     364        @param passphraseFilePath: a file containing the user's pass-phrase.   
    365365        Use this as an alternative to passphrase keyword. 
    366366                                  
    367367        @type createServerSess: bool 
    368         @keyword createServerSess: If set to True, the SessionMgr will create 
     368        @param createServerSess: If set to True, the SessionMgr will create 
    369369        and manage a session for the user.  For non-browser client case, it's  
    370370        possible to choose to have a client or server side session using this  
     
    399399         
    400400        @type userCert: string                  
    401         @keyword userCert: user's certificate used to identifier which session 
     401        @param userCert: user's certificate used to identifier which session 
    402402        to disconnect.  This arg is not needed if the message is signed with 
    403403        the user cert or if sessID is set.   
    404404                                
    405405        @type sessID: string 
    406         @keyword sessID: session ID.  Input this as an alternative to userCert 
     406        @param sessID: session ID.  Input this as an alternative to userCert 
    407407        This arg is not needed if the message is signed with the user cert or  
    408408        if userCert keyword is.""" 
     
    437437              
    438438        @type proxyCert: string 
    439         @keyword proxyCert: proxy certificate - use as ID instead of session  
     439        @param proxyCert: proxy certificate - use as ID instead of session  
    440440        ID.  This can be omitted if the message is signed with a proxy  
    441441        certificate.  In this case the proxy certificate is passed in the  
     
    443443         
    444444        @type sessID: string 
    445         @keyword sessID: session ID.  Input this as an alternative to  
     445        @param sessID: session ID.  Input this as an alternative to  
    446446        proxyCert in the case of a browser client. 
    447447         
    448448        @type attAuthorityURI: string 
    449         @keyword attAuthorityURI: URI for Attribute Authority WS. 
     449        @param attAuthorityURI: URI for Attribute Authority WS. 
    450450         
    451451        @type attAuthorityCert: string 
    452         @keyword attAuthorityCert: The Session Manager uses the Public key of  
     452        @param attAuthorityCert: The Session Manager uses the Public key of  
    453453        the Attribute Authority to encrypt requests to it. 
    454454         
    455455        @type reqRole: string 
    456         @keyword reqRole: The required role for access to a data set.  This  
     456        @param reqRole: The required role for access to a data set.  This  
    457457        can be left out in which case the Attribute Authority just returns  
    458458        whatever Attribute Certificate it has for the user 
    459459         
    460460        @type mapFromTrustedHosts: bool 
    461         @keyword mapFromTrustedHosts: Allow a mapped Attribute Certificate to  
     461        @param mapFromTrustedHosts: Allow a mapped Attribute Certificate to  
    462462        be created from a user certificate from another trusted host. 
    463463         
    464464        @type rtnExtAttCertList: bool 
    465         @keyword rtnExtAttCertList: Set this flag True so that if the  
     465        @param rtnExtAttCertList: Set this flag True so that if the  
    466466        attribute request is denied, a list of potential attribute  
    467467        certificates for mapping may be returned.  
    468468         
    469469        @type extAttCertList: list 
    470         @keyword extAttCertList: A list of Attribute Certificates from other 
     470        @param extAttCertList: A list of Attribute Certificates from other 
    471471        trusted hosts from which the target Attribute Authority can make a  
    472472        mapped certificate 
    473473         
    474474        @type extTrustedHostList: list 
    475         @keyword extTrustedHostList: A list of trusted hosts that can be used  
     475        @param extTrustedHostList: A list of trusted hosts that can be used  
    476476        to get Attribute Certificates for making a mapped AC. 
    477477         
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/X509.py

    r2926 r2927  
    436436        trust.  Validate the signatures through to a single root issuer.   
    437437 
    438         @keyword x509Cert2Verify: X.509 certificate to be verified default is 
     438        @param x509Cert2Verify: X.509 certificate to be verified default is 
    439439        last in the stack 
    440440        @type x509Cert2Verify: X509Cert 
    441441         
    442         @keyword caX509Stack: X.509 stack containing CA certificates that are 
     442        @param caX509Stack: X.509 stack containing CA certificates that are 
    443443        trusted. 
    444444        @type X509Stack""" 
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/XMLSec.py

    r2909 r2927  
    547547 
    548548        @type xmlTxt: string 
    549         @keyword xmlTxt: text from the XML file to be checked.  If omitted, the 
     549        @param xmlTxt: text from the XML file to be checked.  If omitted, the 
    550550        the existing parse document is used instead.""" 
    551551        
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/ca/__init__.py

    r2909 r2927  
    5353        """ 
    5454        @type uri: string 
    55         @keyword uri: URI for Attribute Authority WS.  Setting it will also 
     55        @param uri: URI for Attribute Authority WS.  Setting it will also 
    5656        initialise the Service Proxy 
    5757                                          
    58         @keyword tracefile: set to file object such as sys.stderr to give  
     58        @param tracefile: set to file object such as sys.stderr to give  
    5959        extra WS debug information 
    6060         
     
    260260         
    261261        @type certReq: M2Crypto.X509.Request 
    262         @keyword certReq: X.509 certificate request.  If omitted, 
     262        @param certReq: X.509 certificate request.  If omitted, 
    263263        _createCertReq method is called to create a new public and private  
    264264        key and a certificate request 
    265265         
    266266        @type CN: string 
    267         @keyword CN: common name component of Distinguished Name for new 
     267        @param CN: common name component of Distinguished Name for new 
    268268        cert.  This keyword is ignored if certReq keyword is set. 
    269269         
    270270        @type openSSLConfigFilePath: string 
    271         @keyword openSSLConfigFilePath: file path for OpenSSL configuration 
     271        @param openSSLConfigFilePath: file path for OpenSSL configuration 
    272272        file from which to get settings for Distinguished Name for new  
    273273        certificate.  This keyword is ignored if certReq keyword is set. 
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/m2CryptoSSLUtility.py

    r2909 r2927  
    3838         
    3939        @type peerCertDN: string 
    40         @keyword peerCertDN: Set the expected Distinguished Name of the 
     40        @param peerCertDN: Set the expected Distinguished Name of the 
    4141        server to avoid errors matching hostnames.  This is useful 
    4242        where the hostname is not fully qualified 
    4343         
    4444        @type peerCertCN: string 
    45         @keyword peerCertCN: enable alternate Common Name to peer 
     45        @param peerCertCN: enable alternate Common Name to peer 
    4646        hostname 
    4747         
    4848        @type caCertList: list type of M2Crypto.X509.X509 types 
    49         @keyword caCertList: CA X.509 certificates - if set the peer cert's  
     49        @param caCertList: CA X.509 certificates - if set the peer cert's  
    5050        CA signature is verified against one of these.  At least one must 
    5151        verify 
    5252         
    5353        @type caCertFilePathList: list string types 
    54         @keyword caCertFilePathList: same as caCertList except input as list 
     54        @param caCertFilePathList: same as caCertList except input as list 
    5555        of CA cert file paths""" 
    5656         
     
    6969        @param peerCert: MyProxy server host certificate as M2Crypto.X509.X509 
    7070        instance 
    71         @keyword host: name of host to check 
     71        @param host: name of host to check 
    7272        """ 
    7373         
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/openssl.py

    r2909 r2927  
    4949         
    5050        @type filePath: string         
    51         @keyword filePath: path to OpenSSL configuration file 
     51        @param filePath: path to OpenSSL configuration file 
    5252         
    5353        @type caDir: string 
    54         @keyword caDir: directory for SimpleCA.  This is substituted for $dir 
     54        @param caDir: directory for SimpleCA.  This is substituted for $dir 
    5555        in OpenSSL config file where present.  caDir can be left out in  
    5656        which case the substitution is not done""" 
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/wsSecurity.py

    r2909 r2927  
    155155        @type binSecTokValType: string 
    156156         
    157         @keyword verifyingCert: X.509 certificate used by verify method to 
     157        @param verifyingCert: X.509 certificate used by verify method to 
    158158        verify a message.  This argument can be omitted if the message to 
    159159        be verified contains the X.509 certificate in the  
     
    163163        ndg.security.common.X509.X509Cert 
    164164         
    165         @keyword verifyingCertFilePath: alternative input to the above, pass  
     165        @param verifyingCertFilePath: alternative input to the above, pass  
    166166        the file path to the certificate stored in a file 
    167167        @type verifyingCertFilePath: string 
    168168         
    169         @keyword signingCert: certificate associated with private key used to 
     169        @param signingCert: certificate associated with private key used to 
    170170        sign a message.  The sign method will add this to the  
    171171        BinarySecurityToken element of the WSSE header.  binSecTokValType 
     
    175175        ndg.security.common.X509.X509Cert 
    176176         
    177         @keyword signingCertFilePath: alternative input to the above, pass  
     177        @param signingCertFilePath: alternative input to the above, pass  
    178178        the file path to the certificate stored in a file 
    179179        @type signingCertFilePath: string 
    180180         
    181         @keyword signingCertChain: pass a list of certificates constituting a  
     181        @param signingCertChain: pass a list of certificates constituting a  
    182182        chain of trust from the certificate used to verifying the signature  
    183183        backward to the CA cert.  The CA cert need not be included.  To use  
     
    186186        @type signingCertChain: list or tuple  
    187187         
    188         @keyword signingPriKey: private key used to be sign method to sign 
     188        @param signingPriKey: private key used to be sign method to sign 
    189189        message 
    190190        @type signingPriKey: M2Crypto.RSA. 
    191191         
    192         @keyword signingPriKeyFilePath: equivalent to the above but pass  
     192        @param signingPriKeyFilePath: equivalent to the above but pass  
    193193        private key from PEM file 
    194194        @type signingPriKeyFilePath: string 
    195195         
    196         @keyword signingPriKeyPwd: password protecting private key.  Set / 
     196        @param signingPriKeyPwd: password protecting private key.  Set / 
    197197        default to None if there is no password. 
    198198        @type signingPriKeyPwd: string or None 
    199199         
    200         @keyword caCertDirPath: establish trust for signature verification.  
     200        @param caCertDirPath: establish trust for signature verification.  
    201201        This is a directory containing CA certificates.  These are used to 
    202202        verify the certificate used to verify the message signature. 
    203203        @type caCertDirPath: string 
    204204         
    205         @keyword caCertFilePathList: same as above except pass in a list of 
     205        @param caCertFilePathList: same as above except pass in a list of 
    206206        file paths instead of a single directory name. 
    207207        @type caCertFilePathList: list or tuple 
    208208         
    209         @keyword refC14nKw: dictionary of keywords to reference  
     209        @param refC14nKw: dictionary of keywords to reference  
    210210        Canonicalization.  Use 'unsuppressedPrefixes' keyword to set  
    211211        unsuppressedPrefixes. 
    212212        @type refC14nKw: dict 
    213213         
    214         @keyword signedInfoC14nKw: keywords to Signed Info Canonicalization. 
     214        @param signedInfoC14nKw: keywords to Signed Info Canonicalization. 
    215215        It uses the same format as refC14nKw above. 
    216216        @type signedInfoC14nKw: dict 
  • TI12-security/trunk/python/ndg.security.server/ndg/security/server/AttAuthority/__init__.py

    r2909 r2927  
    120120 
    121121        @type propFilePath: string 
    122         @keyword propFilePath: path to file containing Attribute Authority 
     122        @param propFilePath: path to file containing Attribute Authority 
    123123        configuration parameters.  It defaults to $NDGSEC_AA_PROPFILEPATH or 
    124124        if not set, $NDGSEC_DIR/conf/attAuthorityProperties.xml 
    125125        @type bReadMapConfig: boolean 
    126         @keyword bReadMapConfig: by default the Map Configuration file is  
     126        @param bReadMapConfig: by default the Map Configuration file is  
    127127        read.  Set this flag to False to override. 
    128128        """ 
     
    344344          
    345345        @type userId: string 
    346         @keyword userId: identifier for the user who is entitled to the roles 
     346        @param userId: identifier for the user who is entitled to the roles 
    347347        in the certificate that is issued.  If this keyword is omitted, then 
    348348        the userId will be set to the DN of the holder. 
     
    355355                   
    356356        @type holderCert: string / ndg.security.common.X509.X509Cert type 
    357         @keyword holderCert: base64 encoded string containing proxy cert./ 
     357        @param holderCert: base64 encoded string containing proxy cert./ 
    358358        X.509 cert object corresponding to the ID who will be the HOLDER of 
    359359        the Attribute Certificate that will be issued.  - Normally, using 
     
    362362        case for NDG security with the DEWS project 
    363363         
    364         @keyword holderCertFilePath: string 
     364        @param holderCertFilePath: string 
    365365        @param holderCertFilePath: file path to proxy/X.509 certificate of  
    366366        candidate holder 
    367367       
    368368        @type userAttCert: string or AttCert type 
    369         @keyword userAttCert: externally provided attribute certificate from  
     369        @param userAttCert: externally provided attribute certificate from  
    370370        another data centre.  This is only necessary if the user is not  
    371371        registered with this attribute authority.  
    372372                        
    373373        @type userAttCertFilePath: string  
    374         @keyword userAttCertFilePath: alternative to userAttCert except pass  
     374        @param userAttCertFilePath: alternative to userAttCert except pass  
    375375        in as a file path to an attribute certificate instead. 
    376376         
     
    603603 
    604604        @type propFilePath: string 
    605         @keyword propFilePath: file path to properties file 
     605        @param propFilePath: file path to properties file 
    606606        """ 
    607607 
     
    675675 
    676676        @type mapConfigFilePath: string 
    677         @keyword mapConfigFilePath: file path for map configuration file.  If  
     677        @param mapConfigFilePath: file path for map configuration file.  If  
    678678        omitted, it uses member variable __prop['mapConfigFile']. 
    679679        """ 
     
    894894 
    895895        @type role: string 
    896         @keyword role: if set, return trusted hosts that having a mapping set  
     896        @param role: if set, return trusted hosts that having a mapping set  
    897897        for this role.  If no role is input, return all the AA's trusted hosts  
    898898        with all their possible roles 
     
    10051005         
    10061006        @type backUpCnt: int 
    1007         @keyword backUpCnt: set the number of files to store before rotating 
     1007        @param backUpCnt: set the number of files to store before rotating 
    10081008        and overwriting old files.""" 
    10091009         
     
    10471047         
    10481048        @type dbURI: string 
    1049         @keyword dbURI: database connection URI 
     1049        @param dbURI: database connection URI 
    10501050        @type filePath: string 
    1051         @keyword filePath: file path for properties file containing settings 
     1051        @param filePath: file path for properties file containing settings 
    10521052        """ 
    10531053        pass 
  • TI12-security/trunk/python/ndg.security.server/ndg/security/server/MyProxy.py

    r2909 r2927  
    6363         
    6464        @type myProxyServerDN: string 
    65         @keyword myProxyServerDN: Set the expected Distinguished Name of the 
     65        @param myProxyServerDN: Set the expected Distinguished Name of the 
    6666        MyProxy server to avoid errors matching hostnames.  This is useful 
    6767        where the hostname is not fully qualified 
    6868         
    6969        @type cnHostPfx: string 
    70         @keyword cnHostPfx: globus host certificates are  
     70        @param cnHostPfx: globus host certificates are  
    7171        generated by default with a 'host/' prefix to the host name.  Set 
    7272        this keyword to '' or None to override and omit the prefix""" 
     
    8282        @param peerCert: MyProxy server host certificate as M2Crypto.X509.X509 
    8383        instance 
    84         @keyword host: name of host to check 
     84        @param host: name of host to check 
    8585        """ 
    8686         
     
    248248 
    249249        @type propFilePath: string 
    250         @keyword propFilePath: set to read from the specified file 
     250        @param propFilePath: set to read from the specified file 
    251251         
    252252        @type propElem: ElementTree node 
    253         @keyword propElem: set to read beginning from a cElementTree node 
     253        @param propElem: set to read beginning from a cElementTree node 
    254254        """ 
    255255 
  • TI12-security/trunk/python/ndg.security.server/ndg/security/server/SessionMgr/__init__.py

    r2909 r2927  
    175175         
    176176        @type encrKey: string 
    177         @keyword encrKey: 16 char encryption key used to encrypt the URI.  If 
     177        @param encrKey: 16 char encryption key used to encrypt the URI.  If 
    178178        omitted or set None, the URI is not encrypted but merely base 64 
    179179        encoded""" 
     
    215215         
    216216        @type encrKey: string 
    217         @keyword encrKey: 16 char encryption key used to encrypt the URI.  If 
     217        @param encrKey: 16 char encryption key used to encrypt the URI.  If 
    218218        omitted or set None, the URI is assumed to be unencrypted""" 
    219219 
     
    260260         
    261261        @type sessID: string 
    262         @keyword sessID: if no session ID is provided, use the latest one to  
     262        @param sessID: if no session ID is provided, use the latest one to  
    263263        be allocated. 
    264264         
    265265        @type cookieDomain: string 
    266         @keyword cookieDomain: domain set for cookie, if non set, web server 
     266        @param cookieDomain: domain set for cookie, if non set, web server 
    267267        domain name is used.  Nb. Generalised domains which don't set a  
    268268        specific host can be a security risk. 
    269269         
    270270        @type asString: bool 
    271         @keyword asString: Set to True to return the cookie as string text.   
     271        @param asString: Set to True to return the cookie as string text.   
    272272        If False, it is returned as a SessionCookie instance. 
    273273         
     
    433433         
    434434        @type credReposPPhrase: string 
    435         @keyword credReposPPhrase: password for CredentialRepository database 
     435        @param credReposPPhrase: password for CredentialRepository database 
    436436        This is passed into the Credential Repository object but may not 
    437437        be needed.  e.g. the custom class could pick up a password from 
     
    439439         
    440440        @type Force: boolean 
    441         @keyword Force: flag to force reload of Credential Repository instance 
     441        @param Force: flag to force reload of Credential Repository instance 
    442442        """ 
    443443         
     
    604604         
    605605        @type propElem: Element 
    606         @keyword propElem: pass in existing ElementTree treeroot 
     606        @param propElem: pass in existing ElementTree treeroot 
    607607        """ 
    608608 
     
    773773 
    774774        @type createUserSess: bool 
    775         @keyword createServerSess: If set to True, the SessionMgr will create 
     775        @param createServerSess: If set to True, the SessionMgr will create 
    776776        and manage a session for the user.  For command line case, it's  
    777777        possible to choose to have a client or server side session using this  
     
    779779         
    780780        @type username: string 
    781         @keyword username: username of account to connect to 
     781        @param username: username of account to connect to 
    782782 
    783783        @type passphrase: string 
    784         @keyword passphrase: pass-phrase - user with username arg 
     784        @param passphrase: pass-phrase - user with username arg 
    785785         
    786786        @type proxyCert: string 
    787         @keyword proxyCert: connect to existing session with proxy certificate 
     787        @param proxyCert: connect to existing session with proxy certificate 
    788788        corresponding to user.  username/pass-phrase not required 
    789789         
    790790        @type sessID: string 
    791         @keyword sessID: connect to existing session corresponding to this ID. 
     791        @param sessID: connect to existing session corresponding to this ID. 
    792792        username/pass-phrase not required. 
    793793         
     
    906906         
    907907        @type userCert: string 
    908         @keyword userCert: proxy certificate string corresponding to an  
     908        @param userCert: proxy certificate string corresponding to an  
    909909        existing session to connect to. 
    910910         
    911911        @type sessID: string 
    912         @keyword sessID: similiarly, a web browser session ID linking to an 
     912        @param sessID: similiarly, a web browser session ID linking to an 
    913913        an existing session.""" 
    914914         
     
    998998         
    999999        @type proxyCert: ndg.security.common.X509.X509Cert  
    1000         @keyword proxyCert: proxy certificate corresponding to an existing  
     1000        @param proxyCert: proxy certificate corresponding to an existing  
    10011001        session to connect to. 
    10021002         
    10031003        @type sessID: string 
    1004         @keyword sessID: similiarly, a web browser session ID linking to an 
     1004        @param sessID: similiarly, a web browser session ID linking to an 
    10051005        an existing session. 
    10061006         
    10071007        @type userSess: UserSession 
    1008         @keyword userSess: user session object to be deleted 
     1008        @param userSess: user session object to be deleted 
    10091009        """ 
    10101010         
     
    10751075 
    10761076        @type userCert: string 
    1077         @keyword userCert: user's certificate to key into their session 
     1077        @param userCert: user's certificate to key into their session 
    10781078         
    10791079        @type sessID: string 
    1080         @keyword sessID: user's ID to key into their session 
     1080        @param sessID: user's ID to key into their session 
    10811081         
    10821082        @type encrSessMgrURI: string 
    1083         @keyword encrSessMgrURI: URI for remote session manager to forward a 
     1083        @param encrSessMgrURI: URI for remote session manager to forward a 
    10841084        request to.  This effectively use THIS session manager as a proxy to 
    10851085        another.  This URI is encrypted with a shared key.  The key is stored 
  • TI12-security/trunk/python/ndg.security.server/ndg/security/server/ca/__init__.py

    r2909 r2927  
    108108          
    109109        @type propFilePath: string        
    110         @keyword propFilePath: XML file containing SimpleCA settings. 
     110        @param propFilePath: XML file containing SimpleCA settings. 
    111111            
    112112        @type caPassphrase: string 
    113         @keyword caPassphrase: pass-phrase for SimpleCA's private key. 
     113        @param caPassphrase: pass-phrase for SimpleCA's private key. 
    114114         
    115115        @type passphraseFilePath: string 
    116         @keyword passphraseFilePath: alternative to caPassphrase, Set  
     116        @param passphraseFilePath: alternative to caPassphrase, Set  
    117117        pass-phrase from a file. 
    118118                                         
     
    338338 
    339339        @type propElem: ElementTree node 
    340         @keyword propElem: set to read beginning from a ElementTree node. 
     340        @param propElem: set to read beginning from a ElementTree node. 
    341341        If not set, file self.__propFilePath will be read"""       
    342342 
     
    525525 
    526526        @type caPassphrase: string 
    527         @keyword caPassphrase: pass-phrase for SimpleCA's private key. 
     527        @param caPassphrase: pass-phrase for SimpleCA's private key. 
    528528         
    529529        @type passphraseFilePath: string 
    530         @keyword passphraseFilePath: alternative to caPassphrase, Set  
     530        @param passphraseFilePath: alternative to caPassphrase, Set  
    531531        pass-phrase from a file. 
    532532        
    533533        @type CN: string 
    534         @keyword CN: common name component of Distinguished Name for new 
     534        @param CN: common name component of Distinguished Name for new 
    535535        cert.  This keyword is ignored if certReq keyword is set. 
    536536 
    537537        @type certReq: M2Crypto.X509.Request 
    538         @keyword certReq: certificate request 
     538        @param certReq: certificate request 
    539539         
    540540        @type **createCertReqKw: dict 
  • TI12-security/trunk/python/ndg.security.server/ndg/security/server/conf/userRoles.py

    r2909 r2927  
    2525         
    2626        @type propertiesFilePath: string 
    27         @keyword propertiesFilePath: file path to a properties from which 
     27        @param propertiesFilePath: file path to a properties from which 
    2828        to initialise the user roles interface. e.g. the file could contain 
    2929        user database settings.  The file path passed corresponds to the  
Note: See TracChangeset for help on using the changeset viewer.