U E,W@sdZddlZddlmZmZddlmZmZddlm Z ddl m Z m Z m Z mZmZmZmZedZedZd Zd ZGd ddeZdd dZddZdddZddZddZddZdS)arCollection is a place where secret items are stored. Normally, only the default collection should be used, but this module allows to use any registered collection. Use :func:`get_default_collection` to get the default collection (and create it, if necessary). Collections are usually automatically unlocked when user logs in, but collections can also be locked and unlocked using :meth:`Collection.lock` and :meth:`Collection.unlock` methods (unlocking requires showing the unlocking prompt to user and can be synchronous or asynchronous). Creating new items and editing existing ones is possible only in unlocked collection.N) SS_PREFIXSS_PATH)LockedExceptionItemNotFoundException)Item)bus_get_objectInterfaceWrapperexec_prompt_glib format_secret open_session to_unicodeunlock_objects CollectionZServicez(/org/freedesktop/secrets/aliases/defaultz+/org/freedesktop/secrets/collection/sessionc@sreZdZdZedfddZddZddZdd d Zd d Z d dZ ddZ ddZ ddZ ddZdddZdS)rzRepresents a collection.NcCsLt||}||_||_||_t|t|_t|tj|_ |j j tddddS)NLabelssZ signature) rbussessioncollection_pathrCOLLECTION_IFACEcollection_ifacedbusPROPERTIES_IFACEcollection_props_ifaceGet)selfrrrZcollection_objr:/usr/lib/python3/dist-packages/secretstorage/collection.py__init__!s  zCollection.__init__cCst|jjtdddS)zDReturns :const:`True` if item is locked, otherwise :const:`False`.ZLockedrr)boolrrrrrrr is_locked-s zCollection.is_lockedcCs|rtddS)zSIf collection is locked, raises :exc:`~secretstorage.exceptions.LockedException`.zCollection is locked!N)r!rr rrrensure_not_locked3szCollection.ensure_not_lockedcCst|j|jg|S)aRequests unlocking the collection. If `callback` is specified, calls it when unlocking is complete (see :func:`~secretstorage.util.exec_prompt` description for details). Otherwise, uses loop from GLib API and returns a boolean representing whether the operation was dismissed.)r rr)rcallbackrrrunlock9szCollection.unlockcCs,t|jt}t|t}|j|jgdddS)zLocks the collection.ZaorN)rrrr SERVICE_IFACEZLockr)r service_obj service_ifacerrrlockAs  zCollection.lockcCs||jjdddS)z/Deletes the collection and all items inside it.rN)r"rZDeleter rrrdeleteGszCollection.deleteccs.|jjtdddD]}t|j||jVqdS)z3Returns a generator of all items in the collection.ZItemsrrN)rrrrrr)r item_pathrrr get_all_itemsLs  zCollection.get_all_itemsccs0|jj|dd}|D]}t|j||jVqdS)z^Returns a generator of items with the given attributes. `attributes` should be a dictionary.a{ss}rN)r SearchItemsrrr)r attributesresultr+rrr search_itemsRs zCollection.search_itemscCs|jjtddd}t|S)zReturns the collection label.rrr)rrrr rlabelrrr get_labelZs zCollection.get_labelcCs ||jjtd|dddS)z!Sets collection label to `label`.rZssvrN)r"rSetrr2rrr set_label`s  zCollection.set_labelF text/plainc Csr||jst|j|_t|j||}tj|dd}td|td|i}|jj |||dd\}}t |j||jS)acCreates a new :class:`~secretstorage.item.Item` with given `label` (unicode string), `attributes` (dictionary) and `secret` (bytestring). If `replace` is :const:`True`, replaces the existing item with the same attributes. If `content_type` is given, also sets the content type of the secret (``text/plain`` by default). Returns the created item.rrz Item.LabelzItem.Attributesza{sv}(oayays)b) r"rr rr rZ DictionaryrrZ CreateItemr) rr3r/ZsecretreplaceZ content_type propertiesZnew_itempromptrrr create_itemfs   zCollection.create_item)N)Fr7)__name__ __module__ __qualname____doc__DEFAULT_COLLECTIONrr!r"r$r(r*r,r1r4r6r;rrrrrs  r)c Cs|s t|}td|i}t|t}t|t}|j||dd\}}t|dkr\t |||dSt ||\} } | rvt dt || |dS)aCreates a new :class:`Collection` with the given `label` and `alias` and returns it. This action requires prompting. If prompt is dismissed, raises :exc:`~secretstorage.exceptions.ItemNotFoundException`. This is synchronous function, uses loop from GLib API.zCollection.Labelza{sv}sr)rzPrompt dismissed.) r rrrr Interfacer%ZCreateCollectionlenrr r) rr3aliasrr9r&r'rr:Z dismissedunlockedrrrcreate_collection{s     rFccs>t|t}t|tj}|jtdddD]}t||Vq(dS)z1Returns a generator of all available collections.Z CollectionsrrN)rrrrBrrr%r)rr&Zservice_props_ifacerrrrget_all_collectionss  rGcCs2z t|WStk r,t|dd|YSXdS)zAReturns the default collection. If it doesn't exist, creates it.ZDefaultdefaultN)rrrF)rrrrrget_default_collections rIcCsfz t|WStk rYnXz t|tWStk r@YnXtt|}|rZ|dStddS)zReturns any collection, in the following order of preference: - The default collection; - The "session" collection (usually temporary); - The first collection in the collections list.rzNo collections found.N)rrSESSION_COLLECTIONlistrG)r collectionsrrrget_any_collections   rMcCsBt|t}t|t}|j|dd}t|dkr8tdt||S)zReturns the collection with the given `alias`. If there is no such collection, raises :exc:`~secretstorage.exceptions.ItemNotFoundException`.srrAzNo collection with such alias.) rrrrBr%Z ReadAliasrCrr)rrDr&r'rrrrget_collection_by_aliass    rOccsFt|t}t|t}|j|dd\}}||D]}t||Vq0dS)zpReturns a generator of items in all collections with the given attributes. `attributes` should be a dictionary.r-rN)rrrrBr%r.r)rr/r&r'lockedrEr+rrrr1s    r1)r)N)N)r?rZsecretstorage.definesrrZsecretstorage.exceptionsrrZsecretstorage.itemrZsecretstorage.utilrrr r r r r rr%r@rJobjectrrFrGrIrMrOr1rrrrs   $]